Metode IContextMenu::GetCommandString (shobjidl_core.h)

Mendapatkan informasi tentang perintah menu pintasan, termasuk string bantuan dan nama yang independen bahasa, atau kanonis untuk perintah.

Sintaks

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

Parameter

idCmd

Jenis: UINT_PTR

Offset pengidentifikasi perintah menu.

uType

Jenis: UINT

Bendera yang menentukan informasi yang akan dikembalikan. Parameter ini dapat memiliki salah satu nilai berikut.

GCS_HELPTEXTA

Mengatur pszName ke string ANSI yang berisi teks bantuan untuk perintah.

GCS_HELPTEXTW

Mengatur pszName ke string Unicode yang berisi teks bantuan untuk perintah.

GCS_VALIDATEA

Mengembalikan S_OK jika item menu ada, atau S_FALSE sebaliknya.

GCS_VALIDATEW

Mengembalikan S_OK jika item menu ada, atau S_FALSE sebaliknya.

GCS_VERBA

Mengatur pszName ke string ANSI yang berisi nama perintah independen bahasa untuk item menu.

GCS_VERBW

Mengatur pszName ke string Unicode yang berisi nama perintah independen bahasa untuk item menu.

pReserved

Jenis: UINT*

Dicadangkan. Aplikasi harus menentukan NULL saat memanggil metode ini dan handler harus mengabaikan parameter ini ketika dipanggil.

pszName

Jenis: LPSTR

Alamat buffer untuk menerima string yang dihentikan null yang diambil.

cchMax

Jenis: UINT

Ukuran buffer, dalam karakter, untuk menerima string yang dihentikan null.

Menampilkan nilai

Jenis: HRESULT

Jika metode ini berhasil, metode ini mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Nama perintah independen bahasa, atau kata kerja, adalah nama yang dapat diteruskan ke metode IContextMenu::InvokeCommand untuk mengaktifkan perintah oleh aplikasi. Teks bantuan adalah deskripsi perintah yang ditampilkan Windows Explorer di bilah statusnya. Ini harus cukup pendek (di bawah 40 karakter).

Beberapa kata kerja umum dapat diidentifikasi dengan nama kanonisnya, misalnya, membuka, mencetak, menghapus, dan mengganti nama. Klien dapat membandingkan string yang diacu oleh pszName dengan nama kanonis ini untuk memeriksa keberadaannya di menu pintasan.

Meskipun pszName dinyatakan sebagai LPSTR, Anda harus mentransmisikannya ke UINT_PTR dan mengembalikan string Unicode jika uFlags diatur ke GCS_HELPTEXTW atau GCS_VERBW. GCS_UNICODE dapat digunakan sebagai bitmask untuk menguji uFlags untuk versi 'W' dan 'A' dari bendera yang dikandungnya.

Persyaratan

Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shobjidl_core.h (termasuk Shobjidl.h)
DLL	Shell32.dll (versi 4.0 atau yang lebih baru)