ImmGetDescriptionW-Funktion (imm.h)

Kopiert die Beschreibung der IME in den angegebenen Puffer.

Syntax

UINT ImmGetDescriptionW(
                  HKL    unnamedParam1,
  [out, optional] LPWSTR lpszDescription,
  [in]            UINT   uBufLen
);

Parameter

unnamedParam1

[out, optional] lpszDescription

Zeiger auf einen Puffer, in dem die Funktion die NULL-beendete Zeichenfolge abruft, die die 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ückgeben soll, die für die vollständige Beschreibung erforderlich ist, ohne das beendende NULL-Zeichen.

Windows NT, Windows 2000, Windows XP: Die Größe des Puffers ist 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, die in Unicode-Zeichen erforderlich ist, mit Ausnahme des Unicode-Abschlusszeichens NULL.

Rückgabewert

Gibt die Anzahl der Zeichen zurück, die in den Ausgabepuffer kopiert wurden. 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. Keiner der Werte enthält das beendende NULL-Zeichen. Für Unicode gibt die Funktion die Anzahl der Unicode-Zeichen zurück, ohne das Unicode-Endzeichen NULL einschließt.

Hinweise

Hinweis

Der imm.h-Header 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 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

Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps],Ostasiatische Sprachunterstützung installiert, 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

Weitere Informationen

Eingabemethoden-Manager

Funktionen des Eingabemethoden-Managers