TSPI_phoneGetExtensionID (Compact 2013)

3/26/2014

This function retrieves the extension identifier that the service provider supports for the indicated phone device.

Syntax

LONG TSPIAPI TSPI_phoneGetExtensionID(
  DWORD dwDeviceID, 
  DWORD dwTSPIVersion, 
  LPPHONEEXTENSIONID lpExtensionID 
);

Parameters

• dwDeviceID
  Phone device to be queried.

• dwTSPIVersion
  Interface version number that is negotiated for this device using the TSPI_phoneNegotiateTSPIVersion function. This function operates according to the interface specification at this version level.

• lpExtensionID
  A pointer to a structure of type PHONEEXTENSIONID. If the service provider supports provider-specific extensions, it fills this structure with the extension identifier of these extensions. If the service provider does not support extensions, it fills this structure with all zeros. An extension identifier of all zeros is not a legal extension identifier, because the all-zeros value is used to indicate that the service provider does not support extensions.

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_NODRIVER	The driver cannot be found.
PHONEERR_OPERATIONFAILED	The operation failed.
PHONEERR_NOMEM	Not enough memory is available.
PHONEERR_OPERATIONUNAVAIL	The operation is unavailable.

Remarks

This function is typically called by TAPI in response to an application calling the phoneNegotiateAPIVersion function. The result returned by the service provider should be appropriate for use in a subsequent call to TSPI_phoneNegotiateExtVersion.

Requirements

Header	tspi.h
Library	CellTSP.dll

See Also

Reference

TSPI Phone Device Functions
TSPI_phoneNegotiateExtVersion
TSPI_phoneNegotiateTSPIVersion