ImmGetCandidateListW-Funktion (immdev.h)

Ruft eine Kandidatenliste ab.

Syntax

DWORD ImmGetCandidateListW(
                  HIMC            unnamedParam1,
  [in]            DWORD           deIndex,
  [out, optional] LPCANDIDATELIST lpCandList,
  [in]            DWORD           dwBufLen
);

Parameter

unnamedParam1

[in] deIndex

Nullbasierter Index der Kandidatenliste.

[out, optional] lpCandList

Zeiger auf eine CANDIDATELIST-Struktur , in der die Funktion die Kandidatenliste abruft.

[in] dwBufLen

Größe des Puffers, der die Kandidatenliste empfangen soll, in Bytes. Die Anwendung kann 0 für diesen Parameter angeben, wenn die Funktion nur die erforderliche Größe des Ausgabepuffers zurückgeben soll.

Rückgabewert

Gibt die Anzahl der Bytes zurück, die bei erfolgreicher Ausführung in den Kandidatenlistenpuffer kopiert wurden. Wenn die Anwendung 0 für den dwBufLen-Parameter angegeben hat, gibt die Funktion die größe zurück, die für den Kandidatenlistenpuffer erforderlich ist.

Die Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist.

Hinweise

Hinweis

Der immdev.h-Header definiert ImmGetCandidateList als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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	immdev.h (einschließen immdev.h, Windows.h)
Bibliothek	Imm32.lib
DLL	Imm32.dll

Weitere Informationen

KANDIDATENLISTE

Eingabemethoden-Manager

Funktionen des Eingabemethoden-Managers