Metodo IContextMenu::GetCommandString (shobjidl_core.h)

Ottiene informazioni su un comando di menu di scelta rapida, inclusa la stringa della Guida e il nome indipendente dalla lingua o canonica per il comando.

Sintassi

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

Parametri

idCmd

Tipo: UINT_PTR

Offset dell'identificatore del comando di menu.

uType

Tipo: UINT

Flag che specificano le informazioni da restituire. Questo parametro può avere uno dei valori seguenti.

GCS_HELPTEXTA

Imposta pszName su una stringa ANSI contenente il testo della Guida per il comando.

GCS_HELPTEXTW

Imposta pszName su una stringa Unicode contenente il testo della Guida per il comando.

GCS_VALIDATEA

Restituisce S_OK se la voce di menu esiste o S_FALSE in caso contrario.

GCS_VALIDATEW

Restituisce S_OK se la voce di menu esiste o S_FALSE in caso contrario.

GCS_VERBA

Imposta pszName su una stringa ANSI contenente il nome del comando indipendente dalla lingua per la voce di menu.

GCS_VERBW

Imposta pszName su una stringa Unicode contenente il nome del comando indipendente dalla lingua per la voce di menu.

pReserved

Tipo: UINT*

Riservato. Le applicazioni devono specificare NULL quando si chiama questo metodo e i gestori devono ignorare questo parametro quando viene chiamato.

pszName

Tipo: LPSTR

Indirizzo del buffer per ricevere la stringa con terminazione Null recuperata.

cchMax

Tipo: UINT

Dimensione del buffer, in caratteri, per ricevere la stringa con terminazione Null.

Valore restituito

Tipo: HRESULT

Se questo metodo ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Il nome del comando indipendente dalla lingua, o verbo, è un nome che può essere passato al metodo IContextMenu::InvokeCommand per attivare un comando da parte di un'applicazione. Il testo della Guida è una descrizione del comando visualizzato in Esplora risorse nella relativa barra di stato. Dovrebbe essere ragionevolmente breve (meno di 40 caratteri).

Diversi verbi comuni possono essere identificati dal nome canonico, ad esempio aprire, stampare, eliminare e rinominare. I client possono confrontare la stringa a cui punta pszName con questi nomi canonici per verificare la presenza nel menu di scelta rapida.

Anche se pszName è dichiarato come LPSTR, è necessario eseguirne il cast in UINT_PTR e restituire una stringa Unicode se uFlags è impostato su GCS_HELPTEXTW o GCS_VERBW. GCS_UNICODE può essere usato come maschera di bit per testare uFlags per le versioni 'W' e 'A' del flag in esso contenute.

Requisiti