Função ImmGetCandidateListW (immdev.h)

Recupera uma lista de candidatos.

Sintaxe

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

Parâmetros

unnamedParam1

[in] deIndex

Índice baseado em zero da lista de candidatos.

[out, optional] lpCandList

Ponteiro para uma estrutura CANDIDATELIST na qual a função recupera a lista de candidatos.

[in] dwBufLen

Tamanho, em bytes, do buffer para receber a lista de candidatos. O aplicativo poderá especificar 0 para esse parâmetro se a função retornar apenas o tamanho necessário do buffer de saída.

Retornar valor

Retorna o número de bytes copiados para o buffer de lista de candidatos se for bem-sucedido. Se o aplicativo tiver fornecido 0 para o parâmetro dwBufLen , a função retornará o tamanho necessário para o buffer de lista de candidatos.

A função retornará 0 se não for bem-sucedida.

Comentários

Observação

O cabeçalho immdev.h define ImmGetCandidateList como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho], suporte ao idioma do Leste Asiático instalado.
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	immdev.h (inclua Immdev.h, Windows.h)
Biblioteca	Imm32.lib
DLL	Imm32.dll

Confira também

CANDIDATELIST

Gerenciador de Métodos de Entrada

Funções do Gerenciador de Métodos de Entrada