Inside Macintosh: Telephony /

Chapter 6 - Telephone Tools / Telephone Tools Reference

Constants

Setup-Definition Code Resource Messages

A telephone tool's setup-definition code resource must be able to handle five messages.

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

Constant descriptions

telSpreflightMsg

Your tool receives this message when an application calls TELSetupPreflight to get a handle to the dialog item list of the basic dialog elements supported by your tool. In response to this message, your tool should return, as its function result, a handle to a list of the basic dialog items needed to set up and configure the tool. The application may them append other items to that list before displaying a setup dialog box. The application is responsible for disposing of that handle.

On entry, parameter p3 points to a long integer that is passed with other setup-definition messages. If your tool needs to allocate and configure any private storage, it should do so now and put the address of that storage into the long integer pointed to by p3. Parameters p1 and p2 are unused.

telSsetupMsg

Your tool receives this message when an application calls TELSetupSetup to initialize items in the dialog item list returned by the TELSetupPreflight function. On entry, parameter p3 points to the tool's private setup storage. Your tool can use the information stored there to configure the dialog items. Parameters p1 and p2 are unused.

telSitemMsg

Your tool receives this message when an application calls TELSetupItem to let your tool process an event that is associated with an item in a custom tool-settings dialog box. On entry, parameter p1 points to the index of an item in the dialog item list, and parameter p3 points to the tool's private setup storage. Your tool can change the selected item by modifying the item number to which p1 points. Parameter p2 is unused.

telSfilterMsg

Your tool receives this message when an application calls TELSetupFilter to let your tool filter an event that is associated with an item in a custom tool-settings dialog box. On entry, parameter p1 points to an event record, p2 points to the index of an item in the dialog item list, and parameter p3 points to the tool's private setup storage. Your tool should respond by returning true if it handled the event and false otherwise.

telScleanupMsg

Your tool receives this message when an application calls TELSetupCleanup or TELSetupXCleanup to have your tool dispose of any storage allocated in TELSetupPreflight and perform other cleanup operations. On entry, parameter p3 points to the tool's private setup storage. Parameter p1 is unused. Parameter p2 is unused (and set to 0) if the application called TELSetupCleanup. If the application called TELSetupXCleanup, parameter p2 is set to 1 if the OKed parameter was true and is 0 if the OKed parameter was false. Your tool can use the value of p2 as it desires.

Note

There is no setup-definition code resource message that corresponds to the TELSetupPostflight function, because TELSetupPostflight requires no action from a telephone tool. The TELSetupPostflight function releases the setup-definition code resource from memory.