ImmGetGuideLineW-Funktion (immdev.h)
Ruft Informationen zu Fehlern ab. Anwendungen verwenden die Informationen für Benutzerbenachrichtigungen.
Syntax
DWORD ImmGetGuideLineW(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPWSTR lpBuf,
[in] DWORD dwBufLen
);
Parameter
[in] unnamedParam1
Handle für den Eingabekontext.
[in] dwIndex
Typ der abzurufenden Richtlinieninformationen. Dieser Parameter kann einen der folgenden Werte aufweisen.
[out, optional] lpBuf
Zeiger auf einen Puffer, in dem die Funktion die Fehlermeldungszeichenfolge abruft. Dieser Parameter enthält NULL , wenn dwIndex nicht GGL_STRING oder GGL_PRIVATE ist oder dwBufLen auf 0 festgelegt ist.
[in] dwBufLen
Größe des Ausgabepuffers in Byte. Die Anwendung legt diesen Parameter auf 0 fest, wenn die Funktion die Puffergröße zurückgeben soll, die zum Empfangen der Fehlermeldungszeichenfolge erforderlich ist, ohne das abschließende NULL-Zeichen.
Rückgabewert
Gibt je nach Wert des dwIndex-Parameters eine Fehlerstufe, einen Fehlerindex oder die Größe einer Fehlermeldungszeichenfolge zurück. Wenn dwIndex GGL_LEVEL ist, ist die Rückgabe einer der folgenden Werte.
Wert | Bedeutung |
---|---|
GL_LEVEL_ERROR | Fehler. Der IME kann möglicherweise nicht fortgesetzt werden. |
GL_LEVEL_FATAL | Schwerwiegender Fehler. Der IME kann nicht fortgesetzt werden, und Daten können verlorengehen. |
GL_LEVEL_INFORMATION | Kein Fehler. Dem Benutzer stehen Informationen zur Verfügung. |
GL_LEVEL_NOGUIDELINE | Kein Fehler. Entfernen Sie die vorherige Fehlermeldung, wenn sie noch angezeigt wird. |
GL_LEVEL_WARNING | Unerwartete Eingabe oder ein anderes Ergebnis. Der Benutzer sollte gewarnt werden, aber die IME kann fortgesetzt werden. |
Wenn dwIndex GGL_INDEX ist, ist der Rückgabewert einer der folgenden Werte.
Wert | Bedeutung |
---|---|
GL_ID_CANNOTSAVE | Das Wörterbuch oder die Statistikdaten können nicht gespeichert werden. |
GL_ID_NOCONVERT | Der IME kann nicht mehr konvertiert werden. |
GL_ID_NODICTIONARY | Der IME kann das Wörterbuch nicht finden, oder das Wörterbuch hat ein unerwartetes Format. |
GL_ID_NOMODULE | Der IME kann das benötigte Modul nicht finden. |
GL_ID_READINGCONFLICT | Ein Lesekonflikt ist aufgetreten. Beispielsweise können einige Vokale nicht zu einem Zeichen zusammengefasst werden. |
GL_ID_TOOMANYSTROKE | Es gibt zu viele Striche für ein Zeichen oder eine Klausel. |
GL_ID_TYPINGERROR | Eingabefehler. Der IME kann diese Eingabe nicht verarbeiten. |
GL_ID_UNKNOWN | Unbekannter Fehler. Weitere Informationen finden Sie in der Fehlermeldungszeichenfolge. |
GL_ID_INPUTREADING | Der IME akzeptiert die Lesezeicheneingabe vom Endbenutzer. |
GL_ID_INPUTRADICAL | Der IME akzeptiert radikale Zeicheneingaben vom Endbenutzer. |
GL_ID_INPUTCODE | Der IME akzeptiert zeichencodeeingaben vom Endbenutzer. |
GL_ID_CHOOSECANDIDATE | Der IME akzeptiert die Auswahl von Kandidatenzeichenfolgen vom Endbenutzer. |
GL_ID_REVERSECONVERSION | Informationen zur umgekehrten Konvertierung sind verfügbar, indem Sie ImmGetGuideLine aufrufen und GGL_PRIVATE angeben. Die abgerufenen Informationen haben das CANDIDATELIST-Format . |
Wenn dwIndex GGL_STRING ist, ist der Rückgabewert die Anzahl der Bytes der in den Puffer kopierten Zeichenfolge. Wenn dwBufLen jedoch 0 ist, entspricht der Rückgabewert der Puffergröße, die zum Empfangen der Zeichenfolge erforderlich ist, ohne das abschließende NULL-Zeichen. Wenn dwBufLen für Unicode 0 ist, entspricht der Rückgabewert der Größe in Bytes ohne das Unicode-Endzeichen NULL.
Wenn dwIndex GGL_PRIVATE ist, ist der Rückgabewert die Anzahl der Intete von Informationen, die in den Puffer kopiert wurden. Wenn dwIndex GGL_PRIVATE und dwBufLen den Wert 0 aufweist, ist der Rückgabewert die Puffergröße, die zum Empfangen der Informationen erforderlich ist.
Hinweise
Anwendungen rufen diese Funktion in der Regel auf, nachdem sie einen IMN_GUIDELINE-Befehl erhalten haben.
Hinweis
Der immdev.h-Header definiert ImmGetGuideLine als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps],Unterstützung für ostasiatische Sprache installiert. |
Unterstützte Mindestversion (Server) | Windows Server 2003 [nur Desktop-Apps] |
Zielplattform | Windows |
Kopfzeile | immdev.h (einschließen immdev.h, Windows.h) |
Bibliothek | Imm32.lib |
DLL | Imm32.dll |