Función ImmGetCandidateListW (immdev.h)

Recupera una lista candidata.

Sintaxis

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

Parámetros

unnamedParam1

[in] deIndex

Índice de base cero de la lista de candidatos.

[out, optional] lpCandList

Puntero a una estructura CANDIDATELIST en la que la función recupera la lista de candidatos.

[in] dwBufLen

Tamaño, en bytes, del búfer para recibir la lista de candidatos. La aplicación puede especificar 0 para este parámetro si la función es devolver solo el tamaño necesario del búfer de salida.

Valor devuelto

Devuelve el número de bytes copiados en el búfer de lista candidata si se ejecuta correctamente. Si la aplicación ha proporcionado 0 para el parámetro dwBufLen , la función devuelve el tamaño necesario para el búfer de lista candidata.

La función devuelve 0 si no se realiza correctamente.

Comentarios

Nota

El encabezado immdev.h define ImmGetCandidateList como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio],compatibilidad con idiomas del Este asiático instaladas.
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	immdev.h (incluya Immdev.h, Windows.h)
Library	Imm32.lib
Archivo DLL	Imm32.dll

Consulte también

CANDIDATELIST

Administrador de métodos de entrada

Funciones del Administrador de métodos de entrada