fonction lineNegotiateAPIVersion (tapi.h)

Article
03/02/2024

La fonction lineNegotiateAPIVersion permet à une application de négocier une version d’API à utiliser.

Syntaxe

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

Paramètres

hLineApp

Gérez l’inscription de l’application avec TAPI.

dwDeviceID

Identificateur de l’appareil de ligne à interroger.

dwAPILowVersion

Première version TAPI avec laquelle l’application est conforme. Le mot d’ordre élevé est le numéro de version principal ; le mot de faible ordre est le numéro de version secondaire.

dwAPIHighVersion

Dernière version tapi avec laquelle l’application est conforme. Le mot d’ordre élevé est le numéro de version principal ; le mot de faible ordre est le numéro de version secondaire.

lpdwAPIVersion

Pointeur vers une variable qui contient le numéro de version TAPI qui a été négocié. Si la négociation réussit, ce nombre se trouve dans la plage entre dwAPILowVersion et dwAPIHighVersion.

lpExtensionID

Pointeur vers une structure de type LINEEXTENSIONID. Si le fournisseur de services pour le dwDeviceID spécifié prend en charge les extensions spécifiques au fournisseur, une fois la négociation réussie, cette structure est remplie avec l’identificateur d’extension de ces extensions. Cette structure contient tous les zéros si la ligne ne fournit aucune extension. Une application peut ignorer le paramètre retourné si elle n’utilise pas d’extensions.

Valeur retournée

Retourne zéro si la requête réussit ou un numéro d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

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

Remarques

Utilisez lineInitializeEx pour déterminer le nombre d’appareils de ligne présents dans le système. L’identificateur d’appareil spécifié par dwDeviceID varie de zéro à un inférieur au nombre d’appareils de ligne présents.

La fonction lineNegotiateAPIVersion est utilisée pour négocier le numéro de version de l’API à utiliser. Il récupère également l’identificateur d’extension pris en charge par l’appareil de ligne et retourne des zéros si aucune extension n’est prise en charge. Si l’application souhaite utiliser les extensions définies par l’identificateur d’extension retourné, elle doit appeler lineNegotiateExtVersion pour négocier la version de l’extension à utiliser.

Le numéro de version de l’API négocié est celui sous lequel TAPI peut fonctionner. Si les plages de versions ne se chevauchent pas, les versions de l’application et de l’API ou du fournisseur de services sont incompatibles et une erreur est retournée.