fonction TSPI_lineGetIcon (tspi.h)
La fonction TSPI_lineGetIcon récupère une icône spécifique à l’appareil de ligne de service à afficher à l’utilisateur.
Syntaxe
LONG TSPIAPI TSPI_lineGetIcon(
DWORD dwDeviceID,
LPCWSTR lpszDeviceClass,
LPHICON lphIcon
);
Paramètres
dwDeviceID
Appareil de ligne 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 icône spécifique à cette classe d’appareil. Ce paramètre est facultatif et peut être laissé null, auquel cas l’icône de niveau le plus élevé associée à l’appareil de ligne plutôt qu’à un périphérique de flux multimédia spécifié est sélectionnée.
Les chaînes autorisées sont les mêmes que pour TSPI_lineGetID. Par exemple, si la ligne 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.
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 :
LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_OPERATIONUNAVAIL.
Remarques
Le fournisseur doit retourner un handle (dans le DWORD pointé par lphIcon) à une ressource d’icône (obtenue à partir du
Fonction LoadIcon ) associée à la ligne spécifiée.
Un fournisseur peut choisir de prendre en charge de nombreuses icônes (sélectionnées par lpszDeviceClass et/ou numéro de ligne), une icône unique (par exemple, pour le fabricant, qui serait retournée pour toutes les demandes TSPI_lineGetIcon , quelle que soit la lpszDeviceClasse 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 (l’icône « ligne » générique).
Configuration requise
| Plateforme cible | Windows |
| En-tête | tspi.h |