Méthode IContextMenu::GetCommandString (shobjidl_core.h)

Obtient des informations sur une commande de menu contextuel, notamment la chaîne d’aide et le nom indépendant de la langue ou canonique de la commande.

Syntaxe

HRESULT GetCommandString(
  UINT_PTR idCmd,
  UINT     uType,
  UINT     *pReserved,
  CHAR     *pszName,
  UINT     cchMax
);

Paramètres

idCmd

Type : UINT_PTR

Décalage de l’identificateur de commande de menu.

uType

Type : UINT

Indicateurs spécifiant les informations à retourner. Ce paramètre peut avoir l’une des valeurs suivantes.

GCS_HELPTEXTA

Définit pszName sur une chaîne ANSI contenant le texte d’aide de la commande.

GCS_HELPTEXTW

Définit pszName sur une chaîne Unicode contenant le texte d’aide de la commande.

GCS_VALIDATEA

Retourne S_OK si l’élément de menu existe, ou S_FALSE autrement.

GCS_VALIDATEW

Retourne S_OK si l’élément de menu existe, ou S_FALSE autrement.

GCS_VERBA

Définit pszName sur une chaîne ANSI contenant le nom de la commande indépendante du langage pour l’élément de menu.

GCS_VERBW

Définit pszName sur une chaîne Unicode contenant le nom de la commande indépendante du langage pour l’élément de menu.

pReserved

Type : UINT*

Réservé. Les applications doivent spécifier NULL lors de l’appel de cette méthode et les gestionnaires doivent ignorer ce paramètre lorsqu’ils sont appelés.

pszName

Type : LPSTR

Adresse de la mémoire tampon pour recevoir la chaîne terminée par null en cours de récupération.

cchMax

Type : UINT

Taille de la mémoire tampon, en caractères, pour recevoir la chaîne terminée par null.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Le nom de la commande indépendante du langage, ou verbe, est un nom qui peut être passé à la méthode IContextMenu::InvokeCommand pour activer une commande par une application. Le texte d’aide est une description de la commande que Windows Explorer affiche dans sa barre de status. Il doit être raisonnablement court (moins de 40 caractères).

Plusieurs verbes courants peuvent être identifiés par leur nom canonique, pour instance, ouvrir, imprimer, supprimer et renommer. Les clients peuvent comparer la chaîne pointée par pszName à ces noms canoniques pour case activée leur présence dans le menu contextuel.

Même si pszName est déclaré en tant que LPSTR, vous devez le convertir en UINT_PTR et retourner une chaîne Unicode si uFlags est défini sur GCS_HELPTEXTW ou GCS_VERBW. GCS_UNICODE peut être utilisé comme masque de bits pour tester uFlags pour les versions « W » et « A » de l’indicateur qu’il contient.

Configuration requise

Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shobjidl_core.h (incluez Shobjidl.h)
DLL	Shell32.dll (version 4.0 ou ultérieure)