ImmGetCompositionStringA-Funktion (imm.h)
Ruft Informationen über die Kompositionszeichenfolge ab.
Syntax
LONG ImmGetCompositionStringA(
HIMC unnamedParam1,
DWORD unnamedParam2,
[out, optional] LPVOID lpBuf,
[in] DWORD dwBufLen
);
Parameter
unnamedParam1
unnamedParam2
[out, optional] lpBuf
Zeiger auf einen Puffer, in dem die Funktion die Informationen zur Kompositionszeichenfolge abruft.
[in] dwBufLen
Größe des Ausgabepuffers in Byte, 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ückgeben soll.
Rückgabewert
Gibt die Anzahl der Bytes zurück, die in den Ausgabepuffer kopiert wurden. Wenn dwBufLen auf 0 festgelegt ist, gibt die Funktion die Puffergröße in Bytes zurück, die zum Empfangen aller angeforderten Informationen erforderlich ist, mit Ausnahme des abschließenden NULL-Zeichens. Der Rückgabewert ist immer die Größe in Bytes, auch wenn die angeforderten Daten eine Unicode-Zeichenfolge sind.
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.
Hinweise
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.
Hinweis
Der imm.h-Header 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 |
|---|---|
| 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 | imm.h (include Immdev.h, Windows.h) |
| Bibliothek | Imm32.lib |
| DLL | Imm32.dll |