lineGetStatusMessages function (tapi.h)

The lineGetStatusMessages function enables an application to query which notification messages the application is set up to receive for events related to status changes for the specified line or any of its addresses.

Syntax

LONG lineGetStatusMessages(
  HLINE   hLine,
  LPDWORD lpdwLineStates,
  LPDWORD lpdwAddressStates
);

Parameters

hLine

Handle to the line device.

lpdwLineStates

Bit array that identifies for which line device status changes a message is to be sent to the application. If a flag is TRUE, that message is enabled; if FALSE, it is disabled. This parameter uses one or more of the LINEDEVSTATE_ Constants.

lpdwAddressStates

Bit array that identifies for which address status changes a message is to be sent to the application. If a flag is TRUE, that message is enabled; if FALSE, disabled. This parameter uses one or more of the LINEADDRESSSTATE_ Constants.

Return value

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

LINEERR_INVALLINEHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_UNINITIALIZED.

Remarks

TAPI defines a number of messages that notify applications about events occurring on lines and addresses. An application may not be interested in receiving all address and line status change messages. The lineSetStatusMessages function can be used to select which messages the application wants to receive. By default, address status and line status reporting is disabled.

Requirements

See also

Basic Telephony Services Reference

LINE_CLOSE

LINE_LINEDEVSTATE

TAPI 2.2 Reference Overview

lineSetStatusMessages