2.2.3.1.33 LINEDEVSTATE_Constants

LINEDEVSTATE_OTHER

0x00000001

Device-status items other than those listed below must have changed. The application checks the current device status to determine which items have changed.

LINEDEVSTATE_RINGING

0x00000002

The switch tells the line to alert the user.

TAPI: Service providers notify applications on each ring cycle by repeatedly sending LINE_LINEDEVSTATE packets that contain this constant. For example, in the United States, service providers send a packet with this constant every six seconds.

TSPI: On a POTS device, the service provider can send the packet whenever the central office sends ring voltage. On digital devices such as ISDN, the service provider might need to synthesize the repetition of the packet if the switch generates only one ring request. Each repetition of the packet shows the ring count increasing, so that the toll-save functions work correctly.

LINEDEVSTATE_CONNECTED

0x00000004

The line was previously disconnected and is now connected to TAPI.

LINEDEVSTATE_DISCONNECTED

0x00000008

This line was previously connected and is now disconnected from TAPI.

LINEDEVSTATE_MSGWAITON

0x00000010

The packet-waiting indicator is turned on.

LINEDEVSTATE_MSGWAITOFF

0x00000020

The packet-waiting indicator is turned off.

LINEDEVSTATE_INSERVICE

0x00000040

The line must be connected to TAPI. This condition happens when TAPI is first activated or when the line wire is physically plugged in and is in service at the switch while TAPI is active.

LINEDEVSTATE_OUTOFSERVICE

0x00000080

The line must be out-of-service at the switch or physically disconnected. TAPI is not to be used to operate on the line device.

LINEDEVSTATE_MAINTENANCE

0x00000100

Maintenance must be performed on the line at the switch. TAPI is not to be used to operate on the line device.

LINEDEVSTATE_OPEN

0x00000200

The line must have been opened by another application.

LINEDEVSTATE_CLOSE

0x00000400

The line must have been closed by another application.

LINEDEVSTATE_NUMCALLS

0x00000800

The number of calls on the line device must have changed.

LINEDEVSTATE_NUMCOMPLETIONS

0x00001000

The number of outstanding call completions on the line device must have changed.

LINEDEVSTATE_TERMINALS

0x00002000

The terminal settings must have changed. This change in settings can happen, for example, if multiple line devices share terminals among them (for example, two lines sharing a phone terminal).

LINEDEVSTATE_ROAMMODE

0x00004000

The roam mode of the line device must have changed.

LINEDEVSTATE_BATTERY

0x00008000

The battery level must have changed significantly (cellular).

LINEDEVSTATE_SIGNAL

0x00010000

The signal level must have changed significantly (cellular).

LINEDEVSTATE_DEVSPECIFIC

0x00020000

The device-specific information about the line must have changed.

LINEDEVSTATE_REINIT

0x00040000

Items must have changed in the configuration of line devices. To become aware of these changes (such as the appearance of new line devices), the application reinitializes its use of TAPI.

LINEDEVSTATE_LOCK

0x00080000

The locked status of the line device changes. For more information, see LINEDEVSTATUSFLAGS_LOCKED in LINEDEVSTATUSFLAGS_Constants.

LINEDEVSTATE_CAPSCHANGE

0x00100000

Indicates that, because of configuration changes made by the user or other circumstances, one or more of the members in the LINEDEVCAPS packet for the address must have changed. The application uses GetDevCaps packet to read the updated packet. If a service provider sends a LINE_LINEDEVSTATE packet containing this value to TAPI, TAPI must pass it along. If a previous TAPI version has been negotiated, the endpoint must receive LINE_LINEDEVSTATE packets specifying LINEDEVSTATE_REINIT, requiring a shut down and re-initialization of the connection to TAPI to obtain the updated information.

LINEDEVSTATE_CONFIGCHANGE

0x00200000

Indicates that configuration changes must have been made to one or more of the media devices that are associated with the line device. The GetDevConfig packet can be used to read the updated information. If a service provider sends a LINE_LINEDEVSTATE packet that contains this value to TAPI, TAPI must pass it along.

LINEDEVSTATE_COMPLCANCEL

0x00800000

Indicates that the call completion that is identified by the completion identifier that is contained in the dwParam2 parameter of the LINE_LINEDEVSTATE packet must have been externally canceled and is no longer considered valid. (If that value were to be passed in a subsequent call to the UncompleteCall packet, the function would fail with LINEERR_INVALCOMPLETIONID). If a service provider sends a LINE_LINEDEVSTATE packet that contains this value to TAPI, TAPI must pass it along.

LINEDEVSTATE_REMOVED

0x01000000

Indicates that the device must have been removed from the computer by the service provider (most likely through user action, through a control panel, or similar utility). A LINE_LINEDEVSTATE packet with this value will typically be immediately followed by a LINE_CLOSE packet on the device. Subsequent attempts to access the device prior to TAPI being reinitialized must result in a LINEERR_NODEVICE error being returned to the application. If a service provider sends a LINE_LINEDEVSTATE packet that contains this value to TAPI, TAPI must pass it along.