IContextMenu::GetCommandString-Methode (shobjidl_core.h)

Ruft Informationen zu einem Kontextmenübefehl ab, einschließlich der Hilfezeichenfolge und des sprachunabhängigen oder kanonischen Namens für den Befehl.

Syntax

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

Parameter

idCmd

Typ: UINT_PTR

Menübefehlsbezeichneroffset.

uType

Typ: UINT

Flags, die die zurückzugebenden Informationen angeben. Dieser Parameter kann einen der folgenden Werte aufweisen.

GCS_HELPTEXTA

Legt pszName auf eine ANSI-Zeichenfolge fest, die den Hilfetext für den Befehl enthält.

GCS_HELPTEXTW

Legt pszName auf eine Unicode-Zeichenfolge fest, die den Hilfetext für den Befehl enthält.

GCS_VALIDATEA

Gibt S_OK zurück, wenn das Menüelement vorhanden ist, oder S_FALSE andernfalls.

GCS_VALIDATEW

Gibt S_OK zurück, wenn das Menüelement vorhanden ist, oder S_FALSE andernfalls.

GCS_VERBA

Legt pszName auf eine ANSI-Zeichenfolge fest, die den sprachunabhängigen Befehlsnamen für das Menüelement enthält.

GCS_VERBW

Legt pszName auf eine Unicode-Zeichenfolge fest, die den sprachunabhängigen Befehlsnamen für das Menüelement enthält.

pReserved

Typ: UINT*

Reserviert. Anwendungen müssen NULL angeben, wenn sie diese Methode aufrufen, und Handler müssen diesen Parameter beim Aufrufen ignorieren.

pszName

Typ: LPSTR

Die Adresse des Puffers, um die abgerufene NULL-beendete Zeichenfolge zu empfangen.

cchMax

Typ: UINT

Größe des Puffers in Zeichen, um die NULL-beendete Zeichenfolge zu empfangen.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Der sprachunabhängige Befehlsname oder das Verb ist ein Name, der an die IContextMenu::InvokeCommand-Methode übergeben werden kann, um einen Befehl von einer Anwendung zu aktivieren. Der Hilfetext ist eine Beschreibung des Befehls, den Windows Explorer in der status leiste anzeigt. Es sollte relativ kurz sein (unter 40 Zeichen).

Mehrere gängige Verben können durch ihren kanonischen Namen für instance, Öffnen, Drucken, Löschen und Umbenennen identifiziert werden. Clients können die Zeichenfolge, auf die von pszName verwiesen wird, mit diesen kanonischen Namen vergleichen, um zu überprüfen, ob sie im Kontextmenü vorhanden sind.

Obwohl pszName als LPSTR deklariert ist, müssen Sie es in UINT_PTR umwandeln und eine Unicode-Zeichenfolge zurückgeben, wenn uFlags auf GCS_HELPTEXTW oder GCS_VERBW festgelegt ist. GCS_UNICODE kann als Bitmaske verwendet werden, um uFlags für "W" und "A"-Versionen des enthaltenen Flags zu testen.

Anforderungen

Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shobjidl_core.h (einschließlich Shobjidl.h)
DLL	Shell32.dll (Version 4.0 oder höher)