Inside Macintosh: Telephony /

Chapter 6 - Telephone Tools / Telephone Tools Reference

Data Structures

Call Appearance Generic Message Parameter Block

Your telephone tool passes a pointer to a call appearance generic message parameter block when responding to a generic call appearance message (such as a message about a conference call or a message about a call disconnect). The call appearance generic message parameter block is defined by the TELCAGenericMsgPB data type.

struct TELCAGenericMsgPB {
   short                   toolID;
   short                   tRef;
   short                   dnRef;
   short                   caRef;
   long                    msg;
   short                   mtype;
   short                   value;
   StringPtr               rmtDN;
   StringPtr               rmtName;
   StringPtr               rmtSubaddress;
   short                   dialType;
};
typedef struct TELCAGenericMsgPB TELCAGenericMsgPB;

Field Description

toolID

The tool ID of your telephone tool.

tRef

The reference number of a telephone terminal. Your telephone tool assigns this number when the terminal is opened. You should not change this number as long as the terminal is open.

dnRef

The reference number of a directory number. You should not change this number as long as the directory number is valid.

caRef

The reference number of a call appearance. You should not change this number as long as the call appearance is valid.

msg

The message your tool is sending to the Telephone Manager.

mtype

A message type. The value in this field varies according to the message specified in the msg field. See the description of each particular message for information about this field.

value

A message value. The value in this field varies according to the message specified in the msg field. See the description of each particular message for information about this field.

rmtDN

A pointer to a Pascal-style string that stores a remote directory number (for example, the directory number being called).

rmtName

A pointer to a Pascal-style string that stores the name associated with a remote directory number.

rmtSubaddress

A pointer to a Pascal-style string that stores the subaddress of the specified remote directory number.

dialType

A value that specifies the type of directory number and name contained in the rmtDN and rmtName fields. See "Dial Types" on page 4-14 for a description of the available dial types.