phoneNegotiateAPIVersion
The phoneNegotiateAPIVersion
allows an application to negotiate an API version to use for the specified
phone device.
LONG phoneNegotiateAPIVersion(
|
HPHONEAPP hPhoneApp, |
|
|
DWORD dwDeviceID, |
|
|
DWORD dwAPILowVersion, |
|
|
DWORD dwAPIHighVersion, |
|
|
LPDWORD lpdwAPIVersion, |
|
|
LPPHONEEXTENSIONID lpExtensionID |
|
|
); |
|
Parameters
hPhoneApp
The handle to
the application's registration with TAPI.
dwDeviceID
The phone
device to be queried.
dwAPILowVersion
The 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.
dwAPIHighVersion
The 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.
lpdwAPIVersion
A pointer to
a DWORD-sized location that contains the API version number that was
negotiated. If negotiation is successful, this number will be in the range dwAPILowVersion
and dwAPIHighVersion.
lpExtensionID
A pointer to
a structure of type PHONEEXTENSIONID. If the service provider for the specified dwDeviceID
supports provider-specific extensions, this structure is filled with the
extension ID of these extensions when negotiation is successful. This structure
contains all zeros if the line provides no extensions. An application can
ignore the returned parameter if it does not use extensions.
Return Values
Returns zero
if the request is successful or a negative error number if an error has
occurred. 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 ID supported by the phone device; zeros
if no extensions are provided.
If the
application wants to use the extensions defined by the returned Extension ID,
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 ID 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