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
Zeigen Sie auf eine CANDIDATELIST- Struktur, in der die Funktion die Kandidatenliste abruft.
[in] dwBufLen
Größe des Puffers in Byte, um die Kandidatenliste zu empfangen. 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 für den Kandidatenlistenpuffer erforderliche Größe zurück.
Die Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist.
Bemerkungen
Anmerkung
Der Immdev.h-Header definiert ImmGetCandidateList 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 |