fonction phoneGetIcon (tapi.h)

  • Article

La fonction phoneGetIcon permet à une application de récupérer une icône spécifique à un appareil de téléphone de service (ou propre au fournisseur) qui peut être affichée à l’utilisateur.

Syntaxe

LONG phoneGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  lpszDeviceClass,
  LPHICON lphIcon
);

Paramètres

dwDeviceID

Identificateur de l’appareil téléphonique 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 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 demande réussit ou un nombre d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

PHONEERR_BADDEVICEID, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPOINTER, PHONEERR_OPERATIONFAILED, PHONEERR_INVALDEVICECLASS, PHONEERR_UNINITIALIZED, PHONEERR_NOMEM, PHONEERR_NODEVICE.

Remarques

La fonction phoneGetIcon oblige le fournisseur à retourner un handle (dans lphIcon) à une ressource icône (obtenue à partir de LoadIcon) associée au téléphone spécifié. 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 après le déchargement du fournisseur, ce qui est peu probable tant que l’application a le téléphone ouvert.

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 phoneGetID. Par exemple, si le téléphone 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/phone », « » ou NULL peuvent être utilisés pour demander l’icône pour le service téléphonique.

Pour les applications qui utilisent une version TAPI antérieure à 2.0, si le fournisseur ne retourne pas d’icône (si la classe d’appareil donnée n’est pas valide ou le fournisseur ne prend pas en charge les icônes), TAPI remplace une icône d’appareil téléphonique de téléphonie générique. Pour les applications utilisant TAPI version 2.0 ou ultérieure, TAPI remplace l’icône de téléphone par défaut uniquement si le paramètre lpszDeviceClass est « tapi/phone », « » 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, phoneGetIcon retourne PHONEERR_INVALDEVICECLASS.

Configuration requise

Condition requise Valeur
Plateforme cible Windows
En-tête tapi.h
Bibliothèque Tapi32.lib
DLL Tapi32.dll

Voir aussi

Fonctions de service téléphonique supplémentaires

Vue d’ensemble de la référence TAPI 2.2

phoneGetID