lineGetLineDevStatus
A version of this page is also available for
4/8/2010
This function enables an application to query the specified open line device for its current status.
Syntax
LONG WINAPI lineGetLineDevStatus(
HLINE hLine,
LPLINEDEVSTATUS lpLineDevStatus
);
Parameters
- hLine
Handle to the open line device to be queried.
- lpLineDevStatus
Pointer to a variably sized data structure of type LINEDEVSTATUS. Upon successful completion of the request, this structure is filled with the line's device status. Prior to calling lineGetLineDevStatus, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.
Return Value
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_RESOURCEUNAVAIL |
The resources are unavailable. |
LINEERR_INVALPOINTER |
The pointer is invalid. |
LINEERR_STRUCTURETOOSMALL |
The structure is too small. |
LINEERR_NOMEM |
Not enough memory is available. |
LINEERR_UNINITIALIZED |
A parameter is uninitialized. |
LINEERR_OPERATIONFAILED |
The operation failed. |
LINEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
Remarks
An application uses lineGetLineDevStatus to query the line device for its current line status. This status information applies globally to all addresses on the line device. Use the lineGetAddressStatus function to determine status information about a specific address on a line.
Note
This function is for TAPI version 2.0 and later.
Requirements
| Header | tapi.h |
| Library | coredll.lib |
| Windows Embedded CE | Windows CE 1.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |