Fungsi ImmGetCompositionStringA (immdev.h)

Mengambil informasi tentang string komposisi.

Sintaksis

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 output adalah string Unicode. Aplikasi mengatur parameter ini ke 0 jika fungsinya adalah mengembalikan ukuran buffer output yang diperlukan.

Mengembalikan nilai

Mengembalikan jumlah byte yang disalin ke buffer output. Jika dwBufLen diatur ke 0, fungsi mengembalikan ukuran buffer, dalam byte, yang diperlukan untuk menerima semua informasi yang diminta, tidak termasuk karakter null yang mengakhiri. Nilai yang dikembalikan selalu ukurannya, 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.

Komentar

Aplikasi memanggil fungsi ini sebagai respons terhadap pesan WM_IME_COMPOSITION atau WM_IME_STARTCOMPOSITION. IMM menghapus informasi ketika aplikasi memanggil fungsi ImmReleaseContext.

Catatan Anda harus menulis kode untuk menangani Hiragana lebar penuh dan Katakana lebar setengah jika aplikasi Anda digunakan dengan Panel Input Lunak (SIP).

 

Nota

Header immdev.h mendefinisikan ImmGetCompositionString sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosem 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 XP [hanya aplikasi desktop],dukungan bahasa Asia Timur terinstal.
server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Platform Target	Windows
Header	immdev.h (termasuk Immdev.h, Windows.h)
Pustaka	Imm32.lib
DLL	Imm32.dll

Lihat juga

ImmReleaseContext

Manajer Metode Input

Fungsi Manajer Metode Input

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION