TSPI_lineGetLineDevStatus (Compact 2013)
3/26/2014
This function queries the specified open line device for its current status. The information returned is global to all addresses on the line.
Syntax
LONG TSPIAPI TSPI_lineGetLineDevStatus(
HDRVLINE hdLine,
LPLINEDEVSTATUS lpLineDevStatus
);
Parameters
- hdLine
Service provider's handle to the line to be queried.
- lpLineDevStatus
Pointer to a variably sized data structure of type LINEDEVSTATUS. This structure is filled with the line's device status.
Return Value
Returns zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this function.
Value |
Description |
|---|---|
LINEERR_INVALLINEHANDLE |
The handle to the line is invalid. |
LINEERR_OPERATIONFAILED |
The operation failed. |
LINEERR_NOMEM |
Not enough memory is available. |
LINEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
LINEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
Remarks
The following table indicates which members of the LINEDEVSTATUS data structure are filled in by TAPI and which are filled in by the service provider. The service provider must preserve (it must not overwrite) the values filled in by TAPI.
Member name |
TAPI |
Service provider |
|---|---|---|
dwTotalSize |
X |
|
dwNeededSize |
|
X |
dwUsedSize |
|
X |
dwNumOpens |
X |
|
dwOpenMediaModes |
X |
|
dwNumActiveCalls |
|
X |
dwNumOnHoldCalls |
|
X |
dwNumOnHoldPendCalls |
|
X |
dwLineFeatures |
|
X |
dwNumCallCompletions |
|
X |
dwRingMode |
|
X |
dwSignalLevel |
|
X |
dwBatteryLevel |
|
X |
dwRoamMode |
|
X |
dwDevStatusFlags |
|
X |
dwTerminalModesSize |
|
X |
dwTerminalModesOffset |
|
X |
dwDevSpecificSize |
|
X |
dwDevSpecificOffset |
|
X |
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |