TSPI_phoneGetDevCaps (Compact 2013)
3/26/2014
This function queries a specified phone device to determine its telephony capabilities.
Syntax
LONG TSPIAPI TSPI_phoneGetDevCaps(
DWORD dwDeviceID,
DWORD dwTSPIVersion,
DWORD dwExtVersion,
LPPHONECAPS lpPhoneCaps
);
Parameters
- dwDeviceID
Phone device to be queried.
- dwTSPIVersion
Negotiated TSPI version number. This value is negotiated for this device through the TSPI_phoneNegotiateTSPIVersion function.
- dwExtVersion
Negotiated extension version number. This value is negotiated for this device through the TSPI_phoneNegotiateExtVersion function.
- lpPhoneCaps
Pointer to memory into which the service provider writes a variably sized structure of type PHONECAPS. Upon successful completion of the request, this structure is filled with phone device capability information. Prior to calling TSPI_phoneGetDevCaps, the application sets the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning 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 method.
Value |
Description |
|---|---|
PHONEERR_INCOMPATIBLEAPIVERSION |
The API version is incompatible. |
PHONEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
PHONEERR_INCOMPATIBLEEXTVERSION |
The extension version is incompatible. |
PHONEERR_OPERATIONFAILED |
The operation failed. |
PHONEERR_NODRIVER |
The driver cannot be found. |
PHONEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
PHONEERR_NOMEM |
Not enough memory is available. |
Remarks
If dwExtVersion is zero, no extension information is requested. If it is nonzero, it holds a value that has already been negotiated for this device with the TSPI_phoneNegotiateExtVersion function. The service provider fills in device- and vendor-specific extended information according to the extension version specified.
After the service provider returns from the TSPI_phoneGetDevCaps function, TAPI sets the dwPhoneStates member of the PHONECAPS structure as follows.
PHONECAPS.dwPhoneStates |=
PHONESTATE_OWNER |
PHONESTATE_MONITORS |
PHONESTATE_REINIT;
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |