Bagikan melalui


Fungsi GetMenuStringA (winuser.h)

Menyalin string teks dari item menu yang ditentukan ke dalam buffer yang ditentukan.

Note Fungsi GetMenuString telah digantikan. Gunakan fungsi GetMenuItemInfo untuk mengambil teks item menu.
 

Sintaksis

int GetMenuStringA(
  [in]            HMENU hMenu,
  [in]            UINT  uIDItem,
  [out, optional] LPSTR lpString,
  [in]            int   cchMax,
  [in]            UINT  flags
);

Parameter

[in] hMenu

Jenis: HMENU

Handel ke menu.

[in] uIDItem

Jenis: UINT

Item menu yang akan diubah, seperti yang ditentukan oleh parameter uFlag.

[out, optional] lpString

Jenis: LPTSTR

Buffer yang menerima string null-terminated. Jika string selama atau lebih lama dari lpString, string dipotong dan karakter null penghentian ditambahkan. Jika lpString NULL, fungsi mengembalikan panjang string menu.

[in] cchMax

Jenis: int

Panjang maksimum, dalam karakter, dari string yang akan disalin. Jika string lebih panjang dari maksimum yang ditentukan dalam parameter nMaxCount, karakter tambahan akan dipotong. Jika nMaxCount adalah 0, fungsi mengembalikan panjang string menu.

[in] flags

Jenis: UINT

Menunjukkan bagaimana parameter uIDItem ditafsirkan. Parameter ini harus menjadi salah satu nilai berikut.

Nilai Arti
MF_BYCOMMAND
0x00000000L
Menunjukkan bahwa uIDItem memberikan pengidentifikasi item menu. Jika bendera MF_BYCOMMAND atau MF_BYPOSITION tidak ditentukan, bendera MF_BYCOMMAND adalah bendera default.
MF_BYPOSITION
0x00000400L
Menunjukkan bahwa uIDItem memberikan posisi relatif berbasis nol dari item menu.

Mengembalikan nilai

Jenis: int

Jika fungsi berhasil, nilai pengembalian menentukan jumlah karakter yang disalin ke buffer, tidak termasuk karakter null yang mengakhiri.

Jika fungsi gagal, nilai yang dikembalikan adalah nol.

Jika item yang ditentukan bukan tipe MIIM_STRING atau MFT_STRING, maka nilai yang dikembalikan adalah nol.

Komentar

Parameter nMaxCount harus satu lebih besar dari jumlah karakter dalam string teks untuk mengakomodasi karakter null yang mengakhiri.

Jika nMaxCount adalah 0, fungsi mengembalikan panjang string menu.

Peringatan Keamanan

Parameter lpString adalah buffer TCHAR , dan nMaxCount adalah panjang string menu dalam karakter. Mengukur parameter ini dengan tidak benar dapat menyebabkan pemotongan string, yang menyebabkan kemungkinan hilangnya data.

Contoh

Misalnya, lihat Membuat Akselerator yang Dapat Diedit Pengguna.

Nota

Header winuser.h mendefinisikan GetMenuString sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat Nilai
klien minimum yang didukung Windows 2000 Professional [hanya aplikasi desktop]
server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Platform Target Windows
Header winuser.h (termasuk Windows.h)
Pustaka User32.lib
DLL User32.dll
set API ext-ms-win-ntuser-menu-l1-1-3 (diperkenalkan di Windows 10, versi 10.0.14393)

Lihat juga

Konseptual

GetMenuItemID

Menu

Referensi