ImmGetCompositionStringA-Funktion (immdev.h)

Artikel
11/20/2024

Ruft Informationen zur Kompositionszeichenfolge ab.

Syntax

LONG ImmGetCompositionStringA(
                  HIMC   unnamedParam1,
                  DWORD  unnamedParam2,
  [out, optional] LPVOID lpBuf,
  [in]            DWORD  dwBufLen
);

Parameter

unnamedParam1

unnamedParam2

[out, optional] lpBuf

Zeigen Sie auf einen Puffer, in dem die Funktion die Informationen zur Kompositionszeichenfolge abruft.

[in] dwBufLen

Größe des Ausgabepuffers in Bytes, auch wenn die Ausgabe eine Unicode-Zeichenfolge ist. Die Anwendung legt diesen Parameter auf 0 fest, wenn die Funktion die Größe des erforderlichen Ausgabepuffers zurückgibt.

Rückgabewert

Gibt die Anzahl der in den Ausgabepuffer kopierten Bytes zurück. Wenn dwBufLen- auf 0 festgelegt ist, gibt die Funktion die Puffergröße in Byte zurück, die erforderlich ist, um alle angeforderten Informationen zu empfangen, mit Ausnahme des endenden Nullzeichens. Der Rückgabewert ist immer die Größe in Bytes, auch wenn es sich bei den angeforderten Daten um eine Unicode-Zeichenfolge handelt.

Diese Funktion gibt einen der folgenden negativen Fehlercodes zurück, wenn sie nicht erfolgreich ist:

IMM_ERROR_NODATA. Kompositionsdaten sind im Eingabekontext nicht bereit.
IMM_ERROR_GENERAL. Allgemeiner Fehler, der von IME erkannt wurde.

Bemerkungen

Eine Anwendung ruft diese Funktion als Reaktion auf die WM_IME_COMPOSITION- oder WM_IME_STARTCOMPOSITION Nachricht auf. Der IMM entfernt die Informationen, wenn die Anwendung die ImmReleaseContext--Funktion aufruft.

Note You must write code to handle both full-width Hiragana and half-width Katakana if your application is used with the Soft Input Panel (SIP).

Anmerkung

Der header immdev.h definiert ImmGetCompositionString 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
mindestens unterstützte Client-	Windows XP [Desktop-Apps nur],Ostasiatische Sprachunterstützung installiert.
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	immdev.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL-	Imm32.dll

Siehe auch

ImmReleaseContext-

Eingabemethoden-Manager

Funktionen des Eingabemethoden-Managers

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION

Freigeben über