TSPI_lineGetCallStatus (Compact 2013)
3/26/2014
This function returns the current status of the specified call.
Syntax
LONG TSPIAPI TSPI_lineGetCallStatus(
HDRVCALL hdCall,
LPLINECALLSTATUS lpCallStatus
);
Parameters
- hdCall
Service provider's handle to the call to be queried for its status. The call state of hdCall can be any state.
- lpCallStatus
Pointer to a variably sized data structure of typeLINECALLSTATUS. This structure is filled with call status information.
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_INVALCALLHANDLE |
The handle to the call 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 LINECALLSTATUS data structure are filled in by the service provider and which members are filled in by TAPI. 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 |
dwCallState |
|
X |
dwCallStateMode |
|
X |
dwCallPrivilege |
X |
|
dwCallFeatures |
|
X |
dwDevSpecificSize |
|
X |
dwDevSpecificOffset |
|
X |
TSPI_lineGetCallStatus returns the dynamic status of a call, whereas the TSPI_lineGetCallInfo function returns primarily static information about a call. Call status information includes the current call state, detailed mode information related to the call while in this state (if any), as well as a list of the available TSPI functions TAPI can invoke on the call while the call is in this state.
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |