lineNegotiateExtVersion

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function allows an application to negotiate an extension version to use with the specified line device. This operation need not be called if the application does not support extensions.

Syntax

LONG WINAPI lineNegotiateExtVersion(
  HLINEAPP hLineApp,
  DWORD dwDeviceID,
  DWORD dwAPIVersion,
  DWORD dwExtLowVersion,
  DWORD dwExtHighVersion,
  LPDWORD lpdwExtVersion 
);

Parameters

  • hLineApp
    Handle to the application's registration with TAPI.
  • dwDeviceID
    Line device to be queried.
  • dwAPIVersion
    TAPI version number that was negotiated for the specified line device using lineNegotiateAPIVersion.
  • dwExtLowVersion
    Least recent extension version of the extension identifier returned by the lineNegotiateAPIVersion function that the application is compliant with. The high-order word is the major version number; the low-order word is the minor version number.
  • dwExtHighVersion
    Most recent extension version of the extension identifier returned by lineNegotiateAPIVersion that the application is compliant with. The high-order word is the major version number; the low-order word is the minor version number.
  • lpdwExtVersion
    Pointer to a DWORD that contains the extension version number that was negotiated. If negotiation succeeds, this number is in the range between dwExtLowVersion and dwExtHighVersion.

Return Value

Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.

Value Description

LINEERR_BADDEVICEID

The device identifier is incorrect.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_INCOMPATIBLEAPIVERSION

The API version is incompatible.

LINEERR_NODRIVER

The driver was not found.

LINEERR_INCOMPATIBLEEXTVERSION

The extension version is incompatible.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_INVALAPPHANDLE

The handle to the applications registration with TAPI is invalid.

LINEERR_RESOURCEUNAVAIL

The resources are unavailable.

LINEERR_INVALPOINTER

The pointer is invalid.

LINEERR_UNINITIALIZED

A parameter is uninitialized.

LINEERR_NODEVICE

The device was not found.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

Remarks

Use the lineInitializeEx function to determine the number of line devices present in the system. The device identifier specified by dwDeviceID varies from zero to one less than the number of line devices present.

The lineNegotiateAPIVersion function negotiates the API version number to use. It also retrieves the extension identifier supported by the line device, which is zeros if no extensions are provided. Version numbers should be incremented by one for each release. Leaving gaps in release version numbering can cause unexpected results.

If the application wants to use the extensions defined by the returned extension identifier, it must call lineNegotiateExtVersion to negotiate the extension version to use.

The extension version number negotiated is that under which the application and service provider must both operate. If version ranges do not overlap, the application and service provider versions are incompatible and an error is returned.

Note

This function is for TAPI version 2.0 and later.

Requirements

Header tapi.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

lineInitializeEx
lineNegotiateAPIVersion