TSPI_lineGetCallInfo (Compact 2013)
3/26/2014
This function returns detailed information about the specified call.
Syntax
LONG TSPIAPI TSPI_lineGetCallInfo(
HDRVCALL hdCall,
LPLINECALLINFO lpCallInfo
);
Parameters
- hdCall
Service provider's handle to the call whose call information is to be retrieved. The call state of hdCall can be any state.
- lpCallInfo
Pointer to a variably sized data structure of type LINECALLINFO. Upon successful completion of the request, this structure is filled with call-related 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 shows which members of the LINECALLINFO data structure are filled in by TAPI and which members 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 |
hLine |
X |
|
dwLineDeviceID |
|
X |
dwAddressID |
|
X |
dwBearerMode |
|
X |
dwRate |
|
X |
dwMediaMode |
|
X |
dwAppSpecific |
|
X |
dwCallID |
|
X |
dwRelatedCallID |
|
X |
dwCallParamFlags |
|
X |
dwCallStates |
X |
|
dwMonitorDigitModes |
X |
|
dwMonitorMediaModes |
X |
|
DialParams |
|
X |
dwOrigin |
|
X |
dwReason |
|
X |
dwCompletionID |
|
X |
dwNumOwners |
X |
|
dwNumMonitors |
X |
|
dwCountryCode |
|
X |
dwTrunk |
|
X |
dwCallerIDFlags |
|
X |
dwCallerIDSize |
|
X |
dwCallerIDOffset |
|
X |
dwCallerIDNameSize |
|
X |
dwCallerIDNameOffset |
|
X |
dwCalledIDFlags |
|
X |
dwCalledIDSize |
|
X |
dwCalledIDOffset |
|
X |
dwCalledIDNameSize |
|
X |
dwCalledIDNameOffset |
|
X |
dwConnectedIDFlags |
|
X |
dwConnectedIDSize |
|
X |
dwConnectedIDOffset |
|
X |
dwConnectedIDNameSize |
|
X |
dwConnectedIDNameOffset |
|
X |
dwRedirectionIDFlags |
|
X |
dwRedirectionIDSize |
|
X |
dwRedirectionIDOffset |
|
X |
dwRedirectionIDNameSize |
|
X |
dwRedirectionIDNameOffset |
|
X |
dwRedirectingIDFlags |
|
X |
dwRedirectingIDSize |
|
X |
dwRedirectingIDOffset |
|
X |
dwRedirectingIDNameSize |
|
X |
dwRedirectingIDNameOffset |
|
X |
dwAppNameSize |
X |
|
dwAppNameOffset |
X |
|
dwDisplayableAddressSize |
X |
|
dwDisplayableAddressOffset |
X |
|
dwCalledPartySize |
X |
|
dwCalledPartyOffset |
X |
|
dwCommentSize |
X |
|
dwCommentOffset |
X |
|
dwDisplaySize |
|
X |
dwDisplayOffset |
|
X |
dwUserUserInfoSize |
|
X |
dwUserUserInfoOffset |
|
X |
dwHighLevelCompSize |
|
X |
dwHighLevelCompOffset |
|
X |
dwLowLevelCompSize |
|
X |
dwLowLevelCompOffset |
|
X |
dwChargingInfoSize |
|
X |
dwChargingInfoOffset |
|
X |
dwTerminalModesSize |
|
X |
dwTerminalModesOffset |
|
X |
dwDevSpecificSize |
|
X |
dwDevSpecificOffset |
|
X |
TAPI fills in the size and offset fields for the dwAppNameSize, dwAppNameOffset, dwCalledPartySize, dwCalledPartyOffset, dwCommentSize, and dwCommentOffset members and updates the value in dwUsedSize to reflect these after calling the service provider.
After the service provider returns from the TSPI_lineGetCallInfo function, TAPI sets the dwCallStates member of the LINECALLINFO structure as follows.
LINECALLINFO.dwCallStates |= LINECALLSTATE_UNKNOWN;
If the service provider models lines as "pools" of channel resources and does inverse multiplexing of a call over several address identifiers, it should consistently choose one of these address identifiers as the primary identifier reported by this function in the LINECALLINFO data structure.
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |