TSPI_providerEnumDevices, fonction (tspi.h)

Article
03/06/2024

TAPI appelle la fonction TSPI_providerEnumDevices avant TSPI_providerInit pour déterminer le nombre d’appareils de ligne et de téléphone pris en charge par le fournisseur de services.

Syntaxe

LONG TSPIAPI TSPI_providerEnumDevices(
  DWORD      dwPermanentProviderID,
  LPDWORD    lpdwNumLines,
  LPDWORD    lpdwNumPhones,
  HPROVIDER  hProvider,
  LINEEVENT  lpfnLineCreateProc,
  PHONEEVENT lpfnPhoneCreateProc
);

Paramètres

dwPermanentProviderID

Identificateur permanent, unique au sein des fournisseurs de services sur ce système, du fournisseur de services en cours d’initialisation.

lpdwNumLines

Pointeur vers un emplacement de mémoire de taille DWORD dans lequel le fournisseur de services doit écrire le nombre de périphériques de ligne qu’il est configuré pour prendre en charge. TAPI initialise la valeur sur 0. Par conséquent, si le fournisseur de services ne parvient pas à écrire une valeur différente, la valeur 0 est supposée.

lpdwNumPhones

Pointeur vers un emplacement de mémoire de taille DWORD dans lequel le fournisseur de services doit écrire le nombre d’appareils téléphoniques qu’il est configuré pour prendre en charge. TAPI initialise la valeur sur 0. Par conséquent, si le fournisseur de services ne parvient pas à écrire une valeur différente, la valeur 0 est supposée.

hProvider

Valeur opaque de taille DWORD qui identifie de manière unique cette instance de ce fournisseur de services pendant cette exécution de l’environnement de téléphonie.

lpfnLineCreateProc

Pointeur vers la procédure de rappel LINEEVENT fournie par TAPI. Le fournisseur de services utilise cette fonction pour envoyer des messages LINE_CREATE lorsqu’un appareil de ligne doit être créé.

lpfnPhoneCreateProc

Pointeur vers la procédure de rappel PHONEEVENT fournie par TAPI. Le fournisseur de services utilise cette fonction pour envoyer des messages PHONE_CREATE lorsqu’un appareil téléphonique doit être créé.

Valeur retournée

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

LINEERR_NOMEM, LINEERR_OPERATIONFAILED.

Remarques

Dans les versions précédentes de TAPI, l’implémentation de cette fonction était facultative. À compter de TAPI 2.0, l’implémentation de cette fonction est obligatoire dans tous les fournisseurs de services. TAPI ne vérifie plus Telephon.ini ou le Registre au démarrage de TAPI pour déterminer le nombre initial de lignes et de téléphones pris en charge par un fournisseur de services.

Un nouvel appareil peut apparaître avant la fin de la procédure de TSPI_providerInit . TAPI gère correctement tous les messages _CREATE pendant l’initialisation du fournisseur.