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

Obtém informações sobre um comando de menu de atalho, incluindo a cadeia de caracteres de ajuda e o nome independente de idioma ou canônico do comando.

Sintaxe

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

Parâmetros

idCmd

Tipo: UINT_PTR

Deslocamento do identificador de comando do menu.

uType

Tipo: UINT

Sinalizadores que especificam as informações a serem retornadas. Esse parâmetro pode ter um dos valores a seguir.

GCS_HELPTEXTA

Define pszName como uma cadeia de caracteres ANSI que contém o texto de ajuda para o comando.

GCS_HELPTEXTW

Define pszName como uma cadeia de caracteres Unicode que contém o texto de ajuda para o comando.

GCS_VALIDATEA

Retorna S_OK se o item de menu existir ou S_FALSE caso contrário.

GCS_VALIDATEW

Retorna S_OK se o item de menu existir ou S_FALSE caso contrário.

GCS_VERBA

Define pszName como uma cadeia de caracteres ANSI que contém o nome do comando independente de linguagem para o item de menu.

GCS_VERBW

Define pszName como uma cadeia de caracteres Unicode que contém o nome do comando independente de idioma para o item de menu.

pReserved

Tipo: UINT*

Reservado. Os aplicativos devem especificar NULL ao chamar esse método e os manipuladores devem ignorar esse parâmetro quando chamados.

pszName

Tipo: LPSTR

O endereço do buffer para receber a cadeia de caracteres terminada em nulo que está sendo recuperada.

cchMax

Tipo: UINT

Tamanho do buffer, em caracteres, para receber a cadeia de caracteres terminada em nulo.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

O nome do comando independente de linguagem, ou verbo, é um nome que pode ser passado para o método IContextMenu::InvokeCommand para ativar um comando por um aplicativo. O texto da ajuda é uma descrição do comando que o Windows Explorer exibe em sua barra de status. Ele deve ser razoavelmente curto (menos de 40 caracteres).

Vários verbos comuns podem ser identificados pelo nome canônico, por exemplo, abrir, imprimir, excluir e renomear. Os clientes podem comparar a cadeia de caracteres apontada por pszName com esses nomes canônicos para marcar para sua presença no menu de atalho.

Embora pszName seja declarado como um LPSTR, você deve convertê-lo em UINT_PTR e retornar uma cadeia de caracteres Unicode se uFlags estiver definido como GCS_HELPTEXTW ou GCS_VERBW. GCS_UNICODE pode ser usado como uma máscara de bits para testar uFlags para versões 'W' e 'A' do sinalizador que ele contém.

Requisitos