Función ImmGetCandidateListA (imm.h)

Recupera una lista candidata.

Sintaxis

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

Parámetros

unnamedParam1

[in] deIndex

Índice de base cero de la lista candidata.

[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 candidata. La aplicación puede especificar 0 para este parámetro si la función devuelve 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.

Observaciones

Nota

El encabezado imm.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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP [solo aplicaciones de escritorio],compatibilidad con idiomas del Este asiático instaladas.
servidor mínimo admitido	Windows Server 2003 [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	imm.h (incluya Immdev.h, Windows.h)
biblioteca de	Imm32.lib
DLL de	Imm32.dll

Consulte también

CANDIDATELIST

del Administrador de métodos de entrada de

funciones del Administrador de métodos de entrada de