fonction lineGetDevConfig (tapi.h)

Article
03/02/2024

La fonction lineGetDevConfig retourne un objet de structure de données « opaque », dont le contenu est spécifique à la ligne (fournisseur de services) et à la classe d’appareil. L’objet de structure de données stocke la configuration actuelle d’un appareil de flux multimédia associé à l’appareil de ligne.

Syntaxe

LONG lineGetDevConfig(
  DWORD       dwDeviceID,
  LPVARSTRING lpDeviceConfig,
  LPCSTR      lpszDeviceClass
);

Paramètres

dwDeviceID

Identificateur de l’appareil de ligne à configurer.

lpDeviceConfig

Pointeur vers l’emplacement de mémoire de type VARSTRING où la structure de configuration de l’appareil est retournée. Une fois la demande terminée, cet emplacement est rempli avec la configuration de l’appareil. Le membre dwStringFormat dans la structure VARSTRING est défini sur STRINGFORMAT_BINARY. Avant d’appeler lineGetDevConfig, l’application doit définir le membre dwTotalSize de cette structure pour indiquer la quantité de mémoire disponible pour TAPI pour retourner des informations.

Note Si les paramètres de taille dans la structure ne sont pas corrects, il est possible que les données soient remplacées. Pour plus d’informations sur la définition des tailles de structure, consultez la rubrique allocation de mémoire .

lpszDeviceClass

Pointeur vers une chaîne terminée par null qui spécifie la classe d’appareil de l’appareil dont la configuration est demandée. Les chaînes lineGetID de la classe d’appareil valides sont les mêmes que celles spécifiées pour la fonction .

Valeur retournée

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

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_UNINITIALIZED, LINEERR_NODEVICE.

Remarques

Les états d’appel sont spécifiques à l’appareil.

La fonction lineGetDevConfig peut être utilisée pour récupérer une structure de données à partir de TAPI qui spécifie la configuration d’un périphérique de flux multimédia associé à un périphérique de ligne particulier. Par exemple, le contenu de cette structure peut spécifier le débit de données, le format de caractères, les schémas de modulation et les paramètres de protocole de contrôle d’erreur pour un périphérique multimédia « datamodem » associé à la ligne.

En règle générale, une application appelle lineGetID pour identifier le périphérique de flux multimédia associé à une ligne, puis appelle lineConfigDialog pour permettre à l’utilisateur de configurer la configuration de l’appareil. Il peut ensuite appeler lineGetDevConfig et enregistrer les informations de configuration dans un annuaire téléphonique (ou une autre base de données) associé à une destination d’appel particulière. Lorsque l’utilisateur souhaite ultérieurement appeler à nouveau la même destination, lineSetDevConfig peut être utilisé pour restaurer les paramètres de configuration sélectionnés par l’utilisateur. Les fonctions lineSetDevConfig, lineConfigDialog et lineGetDevConfig peuvent être utilisées, dans cet ordre, pour permettre à l’utilisateur d’afficher et de mettre à jour les paramètres.

Le format exact des données contenues dans la structure est spécifique à l’API de flux de ligne et de média (classe d’appareil), n’est pas documenté et n’est pas défini. La structure retournée par cette fonction ne peut pas être directement accessible ou manipulée par l’application, mais peut uniquement être stockée intacte et utilisée ultérieurement dans lineSetDevConfig pour restaurer les paramètres. La structure ne peut pas non plus nécessairement être passée à d’autres appareils, même de la même classe d’appareil (bien que cela puisse fonctionner dans certains cas, cela n’est pas garanti).