Fungsi GetMenuStringA (winuser.h)

Artikel
03/15/2023

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

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

Sintaks

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 yang dihentikan null. Jika string panjang atau lebih panjang dari lpString, string dipotok dan karakter null yang mengakhiri ditambahkan. Jika lpString adalah 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 dipotok. 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	Makna
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.

Nilai kembali

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 jenis MIIM_STRING atau MFT_STRING, maka nilai yang dikembalikan adalah nol.

Keterangan

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.

Catatan

Header winuser.h mendefinisikan GetMenuString sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor 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

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	winuser.h (sertakan Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-menu-l1-1-3 (diperkenalkan dalam Windows 10, versi 10.0.14393)

Lihat juga

Konseptual

GetMenuItemID

Referensi