lineGetIconW, fonction (tapi.h)

La fonction lineGetIcon permet à une application de récupérer une icône spécifique à un appareil de ligne de service (ou spécifique au fournisseur) à afficher à l’utilisateur.

Syntaxe

LONG lineGetIconW(
  DWORD   dwDeviceID,
  LPCWSTR lpszDeviceClass,
  LPHICON lphIcon
);

Paramètres

dwDeviceID

Identificateur de l’appareil de ligne dont l’icône est demandée.

lpszDeviceClass

Pointeur vers une chaîne null-terminated qui identifie un nom de classe d’appareil. Cette classe d’appareil permet à l’application 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 de ligne plutôt qu’un appareil de flux multimédia spécifié serait sélectionné.

lphIcon

Pointeur vers un emplacement de mémoire dans lequel la poignée vers l’icône est retournée.

Valeur de retour

Retourne zéro si la requête réussit ou si un numéro d’erreur négatif se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_BADDEVICEID, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALDEVICECLASS, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_NODEVICE.

Remarques

La fonction lineGetIcon permet au fournisseur de renvoyer un handle (dans lphIcon) à une ressource d’icône (obtenue à partir de loadIcon) associée à la ligne spécifiée. Le handle d’icône est destiné à une ressource associée au fournisseur. L’application doit utiliser CopyIcon si elle souhaite référencer l’icône une fois le fournisseur déchargé, ce qui est peu probable tant que l’application a la ligne ouverte.

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 lineGetID. Par exemple, si la ligne prend en charge l’API Comm, en passant « COMM » en tant que lpszDeviceClass le fournisseur renvoie une icône liée spécifiquement aux fonctions de l’appareil Comm du fournisseur de services. Les paramètres « tapi/line », « » ou NULL peuvent être utilisés pour demander l’icône du service de ligne.

Pour les applications utilisant une version d’API antérieure à la version 2.0, si le fournisseur ne retourne pas d’icône (si la classe d’appareil donnée n’est pas valide ou si le fournisseur ne prend pas en charge les icônes), TAPI remplace une icône d’appareil de ligne de téléphonie générique. Pour les applications utilisant l’API version 2.0 ou ultérieure, TAPI remplace l’icône de ligne par défaut uniquement si le paramètre lpszDeviceClass est « tapi/line », « » ou NULL. Pour toute autre classe d’appareil, si la classe d’appareil donnée n’est pas valide ou si le fournisseur ne prend pas en charge les icônes de la classe, lineGetIcon retourne LINEERR_INVALDEVICECLASS.

Note

L’en-tête tapi.h définit lineGetIcon comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
plateforme cible	Windows
d’en-tête	tapi.h
bibliothèque	Tapi32.lib
DLL	Tapi32.dll

Voir aussi

Informations de référence sur les services de téléphonie de base

vue d’ensemble des informations de référence sur TAPI 2.2

lineGetID