Inside Macintosh: Telephony /

Chapter 6 - Telephone Tools / Telephone Tools Reference

Tool-Defined Functions /

MyVSET

Called to handle custom dialog setup operations.

pascal long MyVSET (
                     TELSetupPtr pSetup, 
                     short msg, 
                     long p1, 
                     long p2, 
                     long p3);

pSetup

A pointer to a setup definition structure. See "Setup-Definition Structure" on page 6-70 for a description of this structure.

msg

A constant that identifies the type of message being sent to the telephone tool. See "Setup-Definition Code Resource Messages," beginning on page 6-41 for a complete description of the available messages for a set-up definition code resource.

p1

The first parameter for the specified message.

p2

The second parameter for the specified message.

p3

The third parameter for the specified message.

function result

A result code or a message-specific value. See the description below for specific codes you can return.

DESCRIPTION

The MyVSET function is the entry point to the setup-definition code resource of a telephone tool. It should inspect the message specified by the msg parameter and respond accordingly. Currently, a setup-definition code resource should accept these five messages:

enum {
   telSpreflightMsg        = 0,
   telSsetupMsg            = 1,
   telSitemMsg             = 2,
   telSfilterMsg           = 3,
   telScleanupMsg          = 4
};

The meaning of the parameters p1, p2, and p3 is dependent on the message type specified by the msg parameter. See the descriptions of the setup-definition code resource messages beginning on page 6-41 for information about these parameters for each message.

The function result of the MyVSET function depends on the value passed in the msg parameter. For instance, if msg is telSfilterMsg, then the function should return a Boolean value that indicates whether the tool handled the event passed to it. If your MyVSET function encounters an error, it should return a result code indicating the outcome of the request. You can return an operating-system result code or a Telephone Manager result code. If your function receives any message other than the five listed above, it should return the code telNotSupported.