fonction TSPI_phoneGetIcon (tspi.h)
La fonction TSPI_phoneGetIcon récupère une icône spécifique à un appareil de téléphone de service (ou spécifique au fournisseur) à afficher à l’utilisateur.
Syntaxe
LONG TSPIAPI TSPI_phoneGetIcon(
DWORD dwDeviceID,
LPCWSTR lpszDeviceClass,
LPHICON lphIcon
);
Paramètres
dwDeviceID
Appareil téléphonique dont l’icône est demandée.
lpszDeviceClass
Pointeur vers une chaîne Unicode terminée par null qui identifie un nom de classe d’appareil. Cette classe d’appareil permet à l’appelant de sélectionner une sous-icône spécifique applicable à cette classe d’appareil. Ce paramètre est facultatif et peut être laissé NULL ou vide, auquel cas l’icône de niveau le plus élevé associée à l’appareil téléphonique plutôt qu’un périphérique de flux multimédia spécifié est sélectionnée.
lphIcon
Pointeur vers un emplacement de mémoire dans lequel le handle de l’icône est retourné.
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_INVALDEVICECLASS, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL, PHONEERR_RESOURCEUNAVAIL.
Remarques
TSPI_phoneGetIcon amène le fournisseur à renvoyer un handle (dans le DWORD pointé par lphIcon) à une ressource d’icône (obtenue à partir du
Fonction LoadIcon ) associée au téléphone spécifié. Le handle d’icône concerne une ressource associée au fournisseur.
Le paramètre lpszDeviceClass permet au fournisseur de retourner différentes icônes en fonction du type de service référencé par l’appelant. Les chaînes autorisées sont les mêmes que pour TSPI_phoneGetID. Par exemple, si le téléphone prend en charge l’API Comm, le passage de comm/datamodem en tant que lpszDeviceClass entraîne le retour d’une icône liée spécifiquement aux fonctions d’appareil Comm du fournisseur de services. Pour plus d’informations sur les classes d’appareil courantes, consultez Classes d’appareil TSPI.
Les paramètres « tapi/phone », « » ou NULL peuvent être utilisés pour demander l’icône pour l’appareil téléphonique. Un fournisseur peut choisir de prendre en charge de nombreuses icônes (sélectionnées par lpszDeviceClass et/ou numéro de téléphone), une icône unique (par exemple, pour le fabricant, qui serait retournée pour toutes les demandes phoneGetIcon , quelle que soit lpszDeviceClass sélectionnée), ou aucune icône, auquel cas il définit le DWORD pointé par lphIcon sur NULL. TAPI examine le handle retourné par le fournisseur et, si le fournisseur retourne NULL, TAPI remplace une icône de téléphonie générique incluse en tant que ressource dans TAPI (l’icône de téléphone générique).
Si le fournisseur de services ne prend en charge aucune icône, il peut laisser cette fonction non implémentée, auquel cas TAPI fournit une icône de téléphone générique pour l’application.
Configuration requise
| Plateforme cible | Windows |
| En-tête | tspi.h |