fonction lineGetIcon (tapi.h)

  • Article

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) pour l’afficher à l’utilisateur.

Syntaxe

LONG lineGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  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 terminée par null 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 supérieur associée à l’appareil de ligne plutôt qu’un périphérique de flux multimédia spécifié serait 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 requête réussit ou un numéro d’erreur négatif si une erreur 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 (en lphIcon) à une ressource d’icône (obtenue à partir de LoadIcon) associée à la ligne spécifiée. Le handle d’icône concerne une ressource associée au fournisseur. L’application doit utiliser CopyIcon si elle souhaite référencer l’icône après le déchargement du fournisseur, 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 retourne une icône liée spécifiquement aux fonctions d’appareil Comm du fournisseur de services. Les paramètres « tapi/line », « » ou NULL peuvent être utilisés pour demander l’icône pour le service de ligne.

Pour les applications qui utilisent une version d’API antérieure à 2.0, si le fournisseur ne retourne pas d’icône (que ce soit parce que la classe d’appareil donnée n’est pas valide ou que 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 pour la classe, lineGetIcon retourne LINEERR_INVALDEVICECLASS.

Configuration requise

Condition requise Valeur
Plateforme cible Windows
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 de la référence TAPI 2.2

lineGetID