Fungsi ImmGetDescriptionA (imm.h)
Menyalin deskripsi IME ke buffer yang ditentukan.
Sintaks
UINT ImmGetDescriptionA(
HKL unnamedParam1,
[out, optional] LPSTR lpszDescription,
[in] UINT uBufLen
);
Parameter
unnamedParam1
[out, optional] lpszDescription
Penunjuk ke buffer di mana fungsi mengambil string yang dihentikan null yang menjelaskan IME.
[in] uBufLen
Ukuran, dalam karakter, dari buffer output. Aplikasi mengatur parameter ini ke 0 jika fungsinya adalah mengembalikan ukuran buffer yang diperlukan untuk deskripsi lengkap, tidak termasuk karakter null yang mengakhiri.
Windows NT, Windows 2000, Windows XP: Ukuran buffer dalam karakter Unicode, masing-masing terdiri dari dua byte. Jika parameter diatur ke 0, fungsi mengembalikan ukuran buffer yang diperlukan dalam karakter Unicode, tidak termasuk karakter null penghentian Unicode.
Mengembalikan nilai
Mengembalikan jumlah karakter yang disalin ke buffer output. Jika aplikasi mengatur parameter uBufLen ke 0, fungsi mengembalikan ukuran buffer yang diperlukan untuk menerima deskripsi. Tidak ada nilai yang menyertakan karakter null yang mengakhiri. Untuk Unicode, fungsi mengembalikan jumlah karakter Unicode, tidak termasuk karakter null penghentian Unicode.
Keterangan
Catatan
Header imm.h mendefinisikan ImmGetDescription 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
| Klien minimum yang didukung | Windows XP [hanya aplikasi desktop],dukungan bahasa Asia Timur terinstal., dukungan bahasa Asia Timur terinstal. |
| Server minimum yang didukung | Windows Server 2003 [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | imm.h (termasuk Immdev.h, Windows.h) |
| Pustaka | Imm32.lib |
| DLL | Imm32.dll |