Fungsi ImmGetGuideLineA (imm.h)
Mengambil informasi tentang kesalahan. Aplikasi menggunakan informasi untuk pemberitahuan pengguna.
Sintaks
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR lpBuf,
[in] DWORD dwBufLen
);
Parameter
[in] unnamedParam1
Tangani ke konteks input.
[in] dwIndex
Jenis informasi pedoman untuk diambil. Parameter ini dapat memiliki salah satu nilai berikut.
[out, optional] lpBuf
Penunjuk ke buffer tempat fungsi mengambil string pesan kesalahan. Parameter ini berisi NULL jika dwIndex tidak GGL_STRING atau GGL_PRIVATE atau jika dwBufLen diatur ke 0.
[in] dwBufLen
Ukuran, dalam byte, dari buffer output. Aplikasi mengatur parameter ini ke 0 jika fungsinya adalah mengembalikan ukuran buffer yang diperlukan untuk menerima string pesan kesalahan, tidak termasuk karakter null yang dihentikan.
Mengembalikan nilai
Mengembalikan tingkat kesalahan, indeks kesalahan, atau ukuran string pesan kesalahan, tergantung pada nilai parameter dwIndex . Jika dwIndex GGL_LEVEL, pengembaliannya adalah salah satu nilai berikut.
| Nilai | Makna |
|---|---|
| GL_LEVEL_ERROR | Kesalahan. IME mungkin tidak dapat dilanjutkan. |
| GL_LEVEL_FATAL | Kesalahan fatal. IME tidak dapat dilanjutkan, dan data mungkin hilang. |
| GL_LEVEL_INFORMATION | Tidak ada kesalahan. Informasi tersedia untuk pengguna. |
| GL_LEVEL_NOGUIDELINE | Tidak ada kesalahan. Hapus pesan kesalahan sebelumnya jika masih terlihat. |
| GL_LEVEL_WARNING | Input tak terduga atau hasil lainnya. Pengguna harus diperingatkan, tetapi IME dapat dilanjutkan. |
Jika dwIndex GGL_INDEX, nilai yang dikembalikan adalah salah satu nilai berikut.
| Nilai | Makna |
|---|---|
| GL_ID_CANNOTSAVE | Kamus atau data statistik tidak dapat disimpan. |
| GL_ID_NOCONVERT | IME tidak dapat mengonversi lagi. |
| GL_ID_NODICTIONARY | IME tidak dapat menemukan kamus, atau kamus memiliki format yang tidak terduga. |
| GL_ID_NOMODULE | IME tidak dapat menemukan modul yang diperlukan. |
| GL_ID_READINGCONFLICT | Terjadi konflik pembacaan. Misalnya, beberapa vokal tidak dapat disatukan untuk membentuk satu karakter. |
| GL_ID_TOOMANYSTROKE | Ada terlalu banyak goresan untuk satu karakter atau satu klausa. |
| GL_ID_TYPINGERROR | Kesalahan pengetikan. IME tidak dapat menangani pengetikan ini. |
| GL_ID_UNKNOWN | Kesalahan tidak diketahui. Lihat string pesan kesalahan. |
| GL_ID_INPUTREADING | IME menerima input karakter baca dari pengguna akhir. |
| GL_ID_INPUTRADICAL | IME menerima input karakter radikal dari pengguna akhir. |
| GL_ID_INPUTCODE | IME menerima input kode karakter dari pengguna akhir. |
| GL_ID_CHOOSECANDIDATE | IME menerima pemilihan string kandidat dari pengguna akhir. |
| GL_ID_REVERSECONVERSION | Informasi tentang konversi terbalik tersedia dengan memanggil ImmGetGuideLine, menentukan GGL_PRIVATE. Informasi yang diambil dalam format CANDIDATELIST . |
Jika dwIndex GGL_STRING, nilai yang dikembalikan adalah jumlah byte string yang disalin ke buffer. Namun, jika dwBufLen adalah 0, nilai yang dikembalikan adalah ukuran buffer yang diperlukan untuk menerima string, tidak termasuk karakter null yang mengakhiri. Untuk Unicode, jika dwBufLen adalah 0, nilai yang dikembalikan adalah ukurannya, dalam byte tidak termasuk karakter null penghentian Unicode.
Jika dwIndex GGL_PRIVATE, nilai yang dikembalikan adalah jumlah byte informasi yang disalin ke buffer. Jika dwIndex GGL_PRIVATE dan dwBufLen adalah 0, nilai yang dikembalikan adalah ukuran buffer yang diperlukan untuk menerima informasi.
Keterangan
Aplikasi biasanya memanggil fungsi ini setelah menerima perintah IMN_GUIDELINE .
Catatan
Header imm.h mendefinisikan ImmGetGuideLine 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 |