fonction TSPI_phoneGetID (tspi.h)
La fonction TSPI_phoneGetID retourne un identificateur d’appareil pour la classe d’appareil donnée associée à l’appareil téléphonique spécifié.
Syntaxe
LONG TSPIAPI TSPI_phoneGetID(
HDRVPHONE hdPhone,
LPVARSTRING lpDeviceID,
LPCWSTR lpszDeviceClass,
HANDLE hTargetProcess
);
Paramètres
hdPhone
La poignée du téléphone à interroger.
lpDeviceID
Pointeur vers une structure de données de type VARSTRING où l’identificateur d’appareil est retourné. Le format des informations retournées dépend de la méthode utilisée par la classe d’appareil (API) pour nommer les appareils. Avant d’appeler TSPI_phoneGetID, l’application définit le membre dwTotalSize de cette structure pour indiquer la quantité de mémoire disponible sur TAPI pour retourner des informations.
lpszDeviceClass
Pointeur vers une chaîne Unicode terminée par null qui spécifie la classe d’appareil de l’appareil dont l’identificateur est demandé.
hTargetProcess
Handle de processus de l’application pour le compte de laquelle la fonction TSPI_phoneGetID est appelée. Si les informations retournées dans la structure VARSTRING incluent un handle à utiliser par l’application, le fournisseur de services crée ou duplique le handle pour le processus.
Valeur retournée
Retourne zéro si la fonction réussit, ou un numéro d’erreur si une erreur se produit. Les valeurs de retour possibles sont les suivantes :
PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALDEVICECLASS, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL.
Remarques
Cette opération peut être utilisée pour récupérer un identificateur d’appareil téléphonique en fonction d’un handle de téléphone. Il peut également être utilisé pour obtenir l’identificateur de l’appareil multimédia (pour les classes d’appareil telles que COM, wave, MIDI, téléphone, ligne et mciwave) associées à l’appareil téléphonique ouvert. Cet identificateur peut ensuite être utilisé avec l’API multimédia appropriée (par exemple, mci, midi et wav) pour sélectionner l’appareil correspondant. Pour plus d’informations sur les noms de classes d’appareils courants, consultez Classes d’appareils TSPI.
Le fournisseur de services remplit tous les membres de la structure de données VARSTRING , à l’exception de dwTotalSize, qui est renseigné par TAPI. Le fournisseur de services ne doit pas remplacer le membre dwTotalSize .
Le fournisseur de services n’a pas besoin de s’occuper de la gestion des classes d’appareil tapi/ligne et tapi/téléphone, car TAPI les gère pour le fournisseur de services. Par conséquent, le code de gestion de ces classes d’appareils est facultatif.
Configuration requise
Condition requise | Valeur |
---|---|
Plateforme cible | Windows |
En-tête | tspi.h |