Fungsi ImmGetCompositionStringA (imm.h)
Mengambil informasi tentang string komposisi.
Sintaks
LONG ImmGetCompositionStringA(
HIMC unnamedParam1,
DWORD unnamedParam2,
[out, optional] LPVOID lpBuf,
[in] DWORD dwBufLen
);
Parameter
unnamedParam1
unnamedParam2
[out, optional] lpBuf
Penunjuk ke buffer tempat fungsi mengambil informasi string komposisi.
[in] dwBufLen
Ukuran, dalam byte, dari buffer output, bahkan jika outputnya adalah string Unicode. Aplikasi mengatur parameter ini ke 0 jika fungsinya adalah mengembalikan ukuran buffer output yang diperlukan.
Nilai kembali
Mengembalikan jumlah byte yang disalin ke buffer output. Jika dwBufLen diatur ke 0, fungsi mengembalikan ukuran buffer, dalam byte, diperlukan untuk menerima semua informasi yang diminta, tidak termasuk karakter null yang mengakhiri. Nilai yang dikembalikan selalu berukuran, dalam byte, bahkan jika data yang diminta adalah string Unicode.
Fungsi ini mengembalikan salah satu kode kesalahan negatif berikut jika tidak berhasil:
- IMM_ERROR_NODATA. Data komposisi tidak siap dalam konteks input.
- IMM_ERROR_GENERAL. Kesalahan umum terdeteksi oleh IME.
Keterangan
Aplikasi memanggil fungsi ini sebagai respons terhadap pesan WM_IME_COMPOSITION atau WM_IME_STARTCOMPOSITION . IMM menghapus informasi saat aplikasi memanggil fungsi ImmReleaseContext .
Catatan
Header imm.h mendefinisikan ImmGetCompositionString 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 XP [hanya aplikasi desktop],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 |