Share via


TSPI_phoneNegotiateExtVersion (Compact 2013)

3/26/2014

This function returns the highest extension version number the service provider can operate under for this device, given the range of possible extension versions.

Syntax

LONG TSPIAPI TSPI_phoneNegotiateExtVersion(
  DWORD dwDeviceID, 
  DWORD dwTSPIVersion, 
  DWORD dwLowVersion, 
  DWORD dwHighVersion, 
  LPDWORD lpdwExtVersion 
);

Parameters

  • dwDeviceID
    Phone device for which interface version negotiation is to be performed.
  • dwTSPIVersion
    Interface version number that is negotiated for this device using TSPI_phoneNegotiateTSPIVersion. This function operates according to the interface specification at this version level.
  • dwLowVersion
    Lowest extension version number under which TAPI or its client application can operate. The most-significant WORD is the major version number and the least-significant WORD is the minor version number.
  • dwHighVersion
    Highest extension version number under which TAPI or its client application can operate. The most-significant WORD is the major version number and the least-significant WORD is the minor version number.
  • lpdwExtVersion
    Pointer to a DWORD. Upon a successful return from this function, the service provider fills this location with the highest extension version number, within the range requested by the caller, under which the service provider can operate. The most-significant WORD is the major version number and the least-significant WORD is the minor version number. If the requested range does not overlap the range supported by the service provider, the function returns PHONEERR_INCOMPATIBLEEXTVERSION.

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

This function can be called before or after the device has been opened by TAPI. If the device is currently open and has an extension version selected, the function should return that version number if it is within the requested range. If the selected version number is outside the requested range, the function returns PHONEERR_INCOMPATIBLEEXTVERSION.

Requirements

Header

tspi.h

Library

CellTSP.dll

See Also

Reference

TSPI Phone Device Functions
TSPI_phoneNegotiateTSPIVersion