Share via

TSPI_lineGetExtensionID (Compact 2013)

  • Article

3/26/2014

This function returns the extension identifier that the service provider supports for the indicated line device.

Syntax

LONG TSPIAPI TSPI_lineGetExtensionID(
  DWORD dwDeviceID, 
  DWORD dwTSPIVersion, 
  LPLINEEXTENSIONID lpExtensionID  
);

Parameters

  • dwDeviceID
    Line device to be queried.
  • dwTSPIVersion
    Interface version number that was already negotiated for this device using the TSPI_lineNegotiateTSPIVersion function. This function operates according to the interface specification at this version level.
  • lpExtensionID
    Pointer to a structure of type LINEEXTENSIONID. 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. (Therefore, a valid extension identifier cannot consist of all zeros.)

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_NOMEM

Not enough memory is available.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

LINEERR_RESOURCEUNAVAIL

The resource is unavailable.

Remarks

This function is typically called by TAPI in response to an application calling the lineNegotiateAPIVersion function. The result returned by the service provider should be appropriate for use in a subsequent call to the TSPI_lineNegotiateExtVersion function. 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.

Requirements

Header

tspi.h

Library

CellTSP.dll

See Also

Reference

TSPI Line Device Functions
TSPI_lineNegotiateExtVersion
TSPI_lineNegotiateTSPIVersion