ImmGetDescriptionA-Funktion (immdev.h)
Kopiert die Beschreibung des IME in den angegebenen Puffer.
Syntax
UINT ImmGetDescriptionA(
HKL unnamedParam1,
[out, optional] LPSTR lpszDescription,
[in] UINT uBufLen
);
Parameter
unnamedParam1
[out, optional] lpszDescription
Zeigen Sie auf einen Puffer, in dem die Funktion die mit Null beendete Zeichenfolge abruft, die den IME beschreibt.
[in] uBufLen
Größe des Ausgabepuffers in Zeichen. Die Anwendung legt diesen Parameter auf 0 fest, wenn die Funktion die puffergröße zurückgibt, die für die vollständige Beschreibung erforderlich ist, ohne das endende NULL-Zeichen.
Windows NT, Windows 2000, Windows XP: Die Größe des Puffers befindet sich in Unicode-Zeichen, die jeweils aus zwei Bytes bestehen. Wenn der Parameter auf 0 festgelegt ist, gibt die Funktion die Größe des puffers zurück, der in Unicode-Zeichen erforderlich ist, ohne das Unicode-Endzeichen NULL-Zeichen.
Rückgabewert
Gibt die Anzahl der in den Ausgabepuffer kopierten Zeichen zurück. Wenn die Anwendung den uBufLen Parameter auf 0 festlegt, gibt die Funktion die Größe des Puffers zurück, der zum Empfangen der Beschreibung erforderlich ist. Kein Wert enthält das endende NULL-Zeichen. Bei Unicode gibt die Funktion die Anzahl der Unicode-Zeichen zurück, nicht einschließlich des Unicode-Endzeichens null.
Bemerkungen
Anmerkung
Der header immdev.h definiert ImmGetDescription 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., 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 |