Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 4.59 KB

nf-tapi-phonenegotiateapiversion.md

File metadata and controls

124 lines (82 loc) · 4.59 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tapi.phoneNegotiateAPIVersion
phoneNegotiateAPIVersion function (tapi.h)
The phoneNegotiateAPIVersion allows an application to negotiate an API version to use for the specified phone device.
_tapi2_phonenegotiateapiversion
phoneNegotiateAPIVersion
phoneNegotiateAPIVersion function [TAPI 2.2]
tapi/phoneNegotiateAPIVersion
tapi2.phonenegotiateapiversion
tapi2\phonenegotiateapiversion.htm
tapi3
50c2c15c-459f-451b-9b79-9118acc81c8c
12/05/2018
_tapi2_phonenegotiateapiversion, phoneNegotiateAPIVersion, phoneNegotiateAPIVersion function [TAPI 2.2], tapi/phoneNegotiateAPIVersion, tapi2.phonenegotiateapiversion
tapi.h
Windows
Tapi32.lib
Tapi32.dll
Windows
19H1
phoneNegotiateAPIVersion
tapi/phoneNegotiateAPIVersion
c++
APIRef
kbSyntax
DllExport
Tapi32.dll
phoneNegotiateAPIVersion

phoneNegotiateAPIVersion function

-description

The phoneNegotiateAPIVersion allows an application to negotiate an API version to use for the specified phone device.

-parameters

-param hPhoneApp

Handle to the application's registration with TAPI.

-param dwDeviceID

Identifier of the phone device to be queried.

-param dwAPILowVersion

Least recent API version the application is compliant with. The high-order word is the major version number, the low-order word is the minor version number.

-param dwAPIHighVersion

Most recent API version the application is compliant with. The high-order word is the major version number, the low-order word is the minor version number.

-param lpdwAPIVersion

Pointer to a DWORD in which the API version number that was negotiated will be returned. If negotiation succeeds, this number is in the range dwAPILowVersion to dwAPIHighVersion.

-param lpExtensionID

Pointer to a structure of type PHONEEXTENSIONID. If the service provider for the specified dwDeviceID parameter supports provider-specific extensions, this structure is filled with the extension identifier of these extensions when negotiation succeeds. This structure contains all zeros if the line provides no extensions. An application can ignore the returned parameter if it does not use extensions.

-returns

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_BADDEVICEID, PHONEERR_OPERATIONUNAVAIL, PHONEERR_NODRIVER, PHONEERR_NOMEM, PHONEERR_INVALPOINTER, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INCOMPATIBLEAPIVERSION, PHONEERR_UNINITIALIZED, PHONEERR_NODEVICE.

-remarks

The phoneNegotiateAPIVersion function is used to negotiate the API version number to use with the specified phone device. It returns the extension identifier supported by the phone device, or zeros if no extensions are provided.

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

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

The API version number negotiated is that under which TAPI can operate. If version ranges do not overlap, the application, API, or service-provider versions are incompatible and an error is returned.

-see-also

PHONEEXTENSIONID

Supplementary Phone Service Functions

TAPI 2.2 Reference Overview

TAPI Versioning

phoneInitializeEx

phoneNegotiateExtVersion