Fonction DsGetIcon (dsclient.h)
La fonction DsGetIcon obtient l’icône pour une classe d’objet donnée. Cette fonction est obsolète. Les nouvelles applications doivent utiliser la méthode IDsDisplaySpecifier ::GetIcon pour effectuer cette fonction.
Syntaxe
HICON DsGetIcon(
[in] DWORD dwFlags,
[in] LPCWSTR pszObjectClass,
[in] INT cxImage,
[in] INT cyImage
);
Paramètres
[in] dwFlags
Contient un ensemble d’indicateurs qui indiquent le type d’icône à récupérer. Il peut s’agir d’une combinaison d’une ou plusieurs des valeurs suivantes.
DSGIF_ISNORMAL
Obtient l’icône normale pour la classe d’objets.
DSGIF_ISOPEN
Obtient l’icône d’ouverture, telle qu’un dossier ouvert, pour la classe d’objet. Si la classe d’objet n’a pas d’icône ouverte, cette fonction tente d’obtenir l’icône normale pour la classe d’objet.
DSGIF_ISDISABLED
Obtient l’icône désactivée, telle qu’un utilisateur désactivé, pour la classe d’objet. Si la classe d’objet n’a pas d’icône désactivée, cette fonction tente d’obtenir l’icône normale pour la classe d’objet.
DSGIF_GETDEFAULTICON
Si aucune icône n’est trouvée pour la classe d’objet, cette fonction retourne une icône par défaut. Si cet indicateur n’est pas spécifié et qu’aucune icône n’est trouvée pour la classe d’objet, cette fonction retourne NULL.
DSGIF_DEFAULTISCONTAINER
Si aucune icône n’est trouvée pour la classe d’objet, cette fonction renvoie l’icône conteneur en tant qu’icône par défaut. Si cet indicateur n’est pas spécifié et qu’aucune icône n’est trouvée pour la classe d’objet, cette fonction retourne NULL.
[in] pszObjectClass
Pointeur vers une chaîne Unicode terminée par null qui contient le nom de la classe d’objet pour laquelle récupérer l’icône. Les exemples de nom de classe d’objet sont « user » et « container ».
[in] cxImage
Contient la largeur souhaitée, en pixels, de l’icône. Cette fonction récupère l’icône qui correspond le plus à cette largeur.
[in] cyImage
Contient la hauteur souhaitée, en pixels, de l’icône. Cette fonction récupère l’icône qui correspond le plus à cette hauteur.
Valeur retournée
Retourne un handle à l’icône en cas de réussite ou null dans le cas contraire. L’appelant doit détruire cette icône lorsqu’elle n’est plus nécessaire en passant ce handle à DestroyIcon.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | dsclient.h |
| Bibliothèque | Dsuiext.lib |
| DLL | Dsuiext.dll |