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

Obtiene información sobre un comando de menú contextual, incluida la cadena de ayuda y el nombre independiente del lenguaje, o canónico, para el comando.

Sintaxis

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

Parámetros

idCmd

Tipo: UINT_PTR

Desplazamiento del identificador del comando de menú.

uType

Tipo: UINT

Marcas que especifican la información que se va a devolver. Este parámetro puede tener uno de los siguientes valores.

GCS_HELPTEXTA

Establece pszName en una cadena ANSI que contiene el texto de ayuda del comando.

GCS_HELPTEXTW

Establece pszName en una cadena Unicode que contiene el texto de ayuda del comando.

GCS_VALIDATEA

Devuelve S_OK si el elemento de menú existe o S_FALSE de lo contrario.

GCS_VALIDATEW

Devuelve S_OK si el elemento de menú existe o S_FALSE de lo contrario.

GCS_VERBA

Establece pszName en una cadena ANSI que contiene el nombre de comando independiente del idioma para el elemento de menú.

GCS_VERBW

Establece pszName en una cadena Unicode que contiene el nombre de comando independiente del idioma para el elemento de menú.

pReserved

Tipo: UINT*

Reservado. Las aplicaciones deben especificar NULL al llamar a este método y los controladores deben omitir este parámetro cuando se llama a .

pszName

Tipo: LPSTR

Dirección del búfer que se va a recibir la cadena terminada en null que se va a recuperar.

cchMax

Tipo: UINT

Tamaño del búfer, en caracteres, para recibir la cadena terminada en null.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

El nombre de comando independiente del lenguaje, o verbo, es un nombre que se puede pasar al método IContextMenu::InvokeCommand para activar un comando por una aplicación. El texto de ayuda es una descripción del comando que el Explorador de Windows muestra en su barra de estado. Debe ser razonablemente corto (menos de 40 caracteres).

Varios verbos comunes se pueden identificar por su nombre canónico, por ejemplo, abrir, imprimir, eliminar y cambiar el nombre. Los clientes pueden comparar la cadena a la que apunta pszName con estos nombres canónicos para comprobar su presencia en el menú contextual.

Aunque pszName se declara como LPSTR, debe convertirlo en UINT_PTR y devolver una cadena Unicode si uFlags está establecido en GCS_HELPTEXTW o en GCS_VERBW. GCS_UNICODE se puede usar como máscara de bits para probar uFlags para las versiones "W" y "A" de la marca que contiene.

Requisitos

Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	shobjidl_core.h (incluya Shobjidl.h)
Archivo DLL	Shell32.dll (versión 4.0 o posterior)