ImmGetGuideLineA-Funktion (imm.h)
Ruft Informationen zu Fehlern ab. Anwendungen verwenden die Informationen für Benutzerbenachrichtigungen.
Syntax
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR lpBuf,
[in] DWORD dwBufLen
);
Parameter
[in] unnamedParam1
Handle mit dem Eingabekontext.
[in] dwIndex
Art 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 wenn dwBufLen auf 0 festgelegt ist.
[in] dwBufLen
Größe des Ausgabepuffers in Bytes. 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 beendende NULL-Zeichen.
Rückgabewert
Gibt je nach Wert des dwIndex-Parameters eine Fehlerebene, 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. Die IME kann möglicherweise nicht fortgesetzt werden. |
| GL_LEVEL_FATAL | Schwerwiegender Fehler. Die IME kann nicht fortgesetzt werden, und Daten können verlorengehen. |
| GL_LEVEL_INFORMATION | Kein Fehler. Informationen stehen dem Benutzer zur Verfügung. |
| GL_LEVEL_NOGUIDELINE | Kein Fehler. Entfernen Sie die vorherige Fehlermeldung, wenn sie noch sichtbar ist. |
| 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 | Die 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 | Die IME kann das erforderliche Modul nicht finden. |
| GL_ID_READINGCONFLICT | Es ist ein Lesekonflikt aufgetreten. Beispielsweise können einige Vokale nicht zu einem Zeichen zusammengesetzt werden. |
| GL_ID_TOOMANYSTROKE | Es gibt zu viele Striche für ein Zeichen oder eine Klausel. |
| GL_ID_TYPINGERROR | Fehler beim Eingeben. Diese Eingabe kann vom IME nicht verarbeitet werden. |
| GL_ID_UNKNOWN | Unbekannter Fehler. Weitere Informationen finden Sie in der Fehlermeldungszeichenfolge. |
| GL_ID_INPUTREADING | Die IME akzeptiert die Lesezeicheneingaben des Endbenutzers. |
| GL_ID_INPUTRADICAL | Die IME akzeptiert radikale Zeicheneingaben vom Endbenutzer. |
| GL_ID_INPUTCODE | Die IME akzeptiert Zeichencodeeingaben vom Endbenutzer. |
| GL_ID_CHOOSECANDIDATE | Die IME akzeptiert die Auswahl von Kandidatenzeichenfolgen vom Endbenutzer. |
| GL_ID_REVERSECONVERSION | Informationen zur reversen 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 Zeichenfolge, die in den Puffer kopiert wurde. Wenn dwBufLen jedoch 0 ist, ist der Rückgabewert die Puffergröße, die zum Empfangen der Zeichenfolge benötigt wird, ohne das beendende NULL-Zeichen. Wenn für Unicode dwBufLen 0 ist, ist der Rückgabewert die Größe in Bytes, ohne das Unicode-endende NULL-Zeichen.
Wenn dwIndex GGL_PRIVATE ist, ist der Rückgabewert die Anzahl der Bytes von Informationen, die in den Puffer kopiert wurden. Wenn dwIndex GGL_PRIVATE und dwBufLen 0 ist, ist der Rückgabewert die Puffergröße, die zum Empfangen der Informationen benötigt wird.
Hinweise
Anwendungen rufen diese Funktion in der Regel auf, nachdem sie einen IMN_GUIDELINE-Befehl erhalten haben.
Hinweis
Der imm.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 nicht codierungsneutralem Code 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],Ostasiatische Sprachunterstützung installiert. |
| Unterstützte Mindestversion (Server) | Windows Server 2003 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | imm.h (include Immdev.h, Windows.h) |
| Bibliothek | Imm32.lib |
| DLL | Imm32.dll |