Share via


PHONESTATE (Compact 2013)

3/26/2014

These bit-flag constants describe various status items for a phone device.

The following table shows the PHONESTATE constants.

Value

Description

PHONESTATE_CAPSCHANGE = 0x00400000

Indicates that, due to configuration changes made by the user or other circumstances, one or more of the members in the PHONECAPS structure have changed. The application should use phoneGetDevCaps to read the updated structure. If a service provider sends a PHONE_STATE message containing this value to TAPI, TAPI will pass it along to applications that have negotiated TAPI version 1.4 or later; applications negotiating a previous API version will receive PHONE_STATE messages specifying PHONESTATE_REINIT, requiring them to shut down and reinitialize their connection to TAPI to obtain the updated information.

PHONESTATE_CONNECTED = 0x00000002

The connection between the phone device and TAPI was just made. This happens when TAPI is first invoked or when the wire connecting the phone to the PC is plugged in with TAPI active.

PHONESTATE_DEVSPECIFIC = 0x00100000

The phone's device-specific information has changed.

PHONESTATE_DISCONNECTED = 0x00000004

The connection between the phone device and TAPI was just broken. This happens when the wire connecting the phone set to the PC is unplugged while TAPI is active.

PHONESTATE_DISPLAY = 0x00000020

The display of the phone has changed.

PHONESTATE_HANDSETGAIN = 0x00000800

The handset's microphone gain setting has changed.

PHONESTATE_HANDSETHOOKSWITCH = 0x00000200

The handset hookswitch state has changed.

PHONESTATE_HANDSETVOLUME = 0x00000400

The handset's speaker volume setting has changed.

PHONESTATE_HEADSETHOOKSWITCH = 0x00008000

The headset's hookswitch state has changed.

PHONESTATE_HEADSETGAIN = 0x00020000

The headset's microphone gain setting has changed.

PHONESTATE_HEADSETVOLUME = 0x00010000

The headset's speaker volume setting has changed.

PHONESTATE_LAMP = 0x00000040

A lamp of the phone has changed.

PHONESTATE_MONITORS = 0x00000010

The number of monitors for the phone device.

PHONESTATE_OTHER = 0x00000001

Phone-status items other than those listed below have changed. The application should check the current phone status to determine which items have changed.

PHONESTATE_OWNER = 0x00000008

The number of owners for the phone device.

PHONESTATE_REINIT = 0x00200000

Items have changed in the configuration of phone devices. To become aware of these changes, as for the appearance of new phone devices, the application should reinitialize its use of TAPI.

PHONESTATE_REMOVED = 0x00800000

Indicates that the device is being removed from the system by the service provider, most likely through user action, through a control panel, or through a similar utility. A PHONE_STATE message with this value will normally be immediately followed by a PHONE_CLOSE message on the device. Subsequent attempts to access the device prior to TAPI being reinitialized will result in PHONEERR_NODEVICE being returned to the application. If a service provider sends a PHONE_STATE message containing this value to TAPI, TAPI will pass it along to applications that have negotiated TAPI version 1.4 or later. Applications negotiating a previous API version will not receive any notification.

PHONESTATE_RESUME = 0x00080000

The application's use of the phone device is resumed after having been suspended for some time.

PHONESTATE_RINGMODE = 0x00000080

The ring mode of the phone has changed.

PHONESTATE_RINGVOLUME = 0x00000100

The ring volume of the phone has changed.

PHONESTATE_SPEAKERHOOKSWITCH = 0x00001000

The speakerphone's hookswitch state has changed.

PHONESTATE_SPEAKERGAIN = 0x00004000

The speakerphone's microphone gain setting state has changed.

PHONESTATE_SPEAKERVOLUME = 0x00002000

The speakerphone's speaker volume setting has changed.

PHONESTATE_SUSPEND = 0x00040000

The application's use of the phone is temporarily suspended.

Remarks

These constants cannot be extended. All 32 bits are reserved.

Requirements

Header

tapi.h

See Also

Reference

TAPI Constants
phoneGetDevCaps
PHONECAPS
PHONE_STATE (TAPI)