PHONEBUTTONINFO

The PHONEBUTTONINFO structure contains information about a button on a phone device.

typedef struct phonebuttoninfo_tag {
    DWORD  dwTotalSize;
    DWORD  dwNeededSize;
    DWORD  dwUsedSize;

    DWORD  dwButtonMode;
    DWORD  dwButtonFunction;

    DWORD  dwButtonTextSize;
    DWORD  dwButtonTextOffset;

    DWORD  dwDevSpecificSize;
    DWORD  dwDevSpecificOffset;
} PHONEBUTTONINFO, FAR *LPPHONEBUTTONINFO;
 

Members

dwTotalSize

The total size in bytes allocated to this data structure.

dwNeededSize

The size in bytes for this data structure that is needed to hold the returned information.

dwUsedSize

The size in bytes of the portion of this data structure that contains useful information.

dwButtonMode

The mode or general usage class of the button. This member uses the following PHONEBUTTONMODE_ constants:

PHONEBUTTONMODE_DUMMY

This value is used to describe a button/lamp position that has no corresponding button, but has only a lamp.

PHONEBUTTONMODE_CALL

The button is assigned to a call appearance.

PHONEBUTTONMODE_FEATURE

The button is assigned to requesting features from the switch, such as hold, conference, and transfer.

PHONEBUTTONMODE_KEYPAD

The button is one of the twelve keypad buttons, '0' through '9', '*', and '#'.

PHONEBUTTONMODE_LOCAL

The button is a local function button, such as mute or volume control.

PHONEBUTTONMODE_DISPLAY

The button is a "soft" button associated with the phone's display. A phone set can have zero or more display buttons.

dwButtonFunction

The function assigned to the button. This member uses the PHONEBUTTONFUNCTION_ constants (not listed here).

dwButtonTextSize

dwButtonTextOffset

The size in bytes and the offset in bytes from the beginning of this data structure of the variably sized field containing descriptive text for this button. The format of this information is as specified in the dwStringFormat member of the phone's device capabilities.

dwDevSpecificSize

dwDevSpecificOffset

The size in bytes and the offset in bytes from the beginning of this data structure of the variably sized device-specific field.

Remarks

Device-specific extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of this data structure.

See Also

PHONEBUTTONFUNCTION_ Constants, PHONEBUTTONMODE_ Constants, TSPI_phoneGetButtonInfo, TSPI_phoneSetButtonInfo