lineNegotiateAPIVersion-Funktion (tapi.h)

Artikel
08/26/2023

Die lineNegotiateAPIVersion-Funktion ermöglicht es einer Anwendung, eine zu verwendende API-Version auszuhandeln.

Syntax

LONG lineNegotiateAPIVersion(
  HLINEAPP          hLineApp,
  DWORD             dwDeviceID,
  DWORD             dwAPILowVersion,
  DWORD             dwAPIHighVersion,
  LPDWORD           lpdwAPIVersion,
  LPLINEEXTENSIONID lpExtensionID
);

Parameter

hLineApp

Verarbeiten sie die Registrierung der Anwendung bei TAPI.

dwDeviceID

Bezeichner des abzufragten Leitungsgeräts.

dwAPILowVersion

Früheste TAPI-Version, mit der die Anwendung kompatibel ist. Das Wort mit hoher Ordnung ist die Hauptversionsnummer; Das Wort mit niedriger Ordnung ist die Nebenversionsnummer.

dwAPIHighVersion

Neueste TAPI-Version, mit der die Anwendung kompatibel ist. Das Wort mit hoher Ordnung ist die Hauptversionsnummer; Das Wort mit niedriger Ordnung ist die Nebenversionsnummer.

lpdwAPIVersion

Zeiger auf eine Variable, die die ausgehandelte TAPI-Versionsnummer enthält. Wenn die Aushandlung erfolgreich ist, liegt diese Zahl im Bereich zwischen dwAPILowVersion und dwAPIHighVersion.

lpExtensionID

Zeiger auf eine Struktur vom Typ LINEEXTENSIONID. Wenn der Dienstanbieter für die angegebene dwDeviceID anbieterspezifische Erweiterungen unterstützt, wird diese Struktur nach erfolgreicher Aushandlung mit dem Erweiterungsbezeichner dieser Erweiterungen gefüllt. Diese Struktur enthält alle Nullen, wenn die Zeile keine Erweiterungen enthält. Eine Anwendung kann den zurückgegebenen Parameter ignorieren, wenn sie keine Erweiterungen verwendet.

Rückgabewert

Gibt null zurück, wenn die Anforderung erfolgreich ist, oder eine negative Fehlernummer, wenn ein Fehler auftritt. Mögliche Rückgabewerte sind:

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INCOMPATIBLEAPIVERSION, LINEERR_OPERATIONFAILED, LINEERR_INVALAPPHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_OPERATIONUNAVAIL, LINEERR_NODEVICE.

Hinweise

Verwenden Sie lineInitializeEx , um die Anzahl der im System vorhandenen Leitungsgeräte zu bestimmen. Der durch dwDeviceID angegebene Gerätebezeichner variiert von null bis eins kleiner als die Anzahl der vorhandenen Leitungsgeräte.

Die lineNegotiateAPIVersion-Funktion wird verwendet, um die zu verwendende API-Versionsnummer auszuhandeln. Außerdem wird der erweiterungsbezeichner abgerufen, der vom Zeilengerät unterstützt wird, und gibt Nullen zurück, wenn keine Erweiterungen unterstützt werden. Wenn die Anwendung die durch den zurückgegebenen Erweiterungsbezeichner definierten Erweiterungen verwenden möchte, muss sie lineNegotiateExtVersion aufrufen, um die zu verwendende Erweiterungsversion auszuhandeln.

Die ausgehandelte API-Versionsnummer ist die, unter der TAPI betrieben werden kann. Wenn sich die Versionsbereiche nicht überschneiden, sind die Versionen der Anwendung und der API oder des Dienstanbieters inkompatibel, und es wird ein Fehler zurückgegeben.