lineGetStatusMessages
This 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.
LONG WINAPI 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, it is disabled. This parameter uses one or more of the LINEADDRESSSTATE constants.
Return Values
Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.
Value | Description |
---|---|
LINEERR_INVALLINEHANDLE | The handle to the open line device is invalid. |
LINEERR_OPERATIONFAILED | The operation failed. |
LINEERR_INVALPOINTER | The pointer is invalid. |
LINEERR_RESOURCEUNAVAIL | The resource is unavailable. |
LINEERR_NOMEM | Not enough memory is available. |
LINEERR_UNINITIALIZED | A parameter is not initialized. |
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.
Note This function is for TAPI version 2.0 and later.
Requirements
OS Versions: Windows CE 1.0 and later.
Header: Tapi.h.
Link Library: Coredll.lib.
See Also
LINE_CLOSE | lineSetStatusMessages
Last updated on Saturday, April 10, 2004
© 1992-2003 Microsoft Corporation. All rights reserved.