Função ImmGetCandidateListA (imm.h)

Artigo
11/20/2024

Recupera uma lista de candidatos.

Sintaxe

DWORD ImmGetCandidateListA(
                  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 deve retornar apenas o tamanho necessário do buffer de saída.

Valor de retorno

Retorna o número de bytes copiados para o buffer de lista de candidatos se 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.

Observações

Nota

O cabeçalho imm.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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho], suporte à linguagem do Leste Asiático instalado.
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	imm.h (inclua Immdev.h, Windows.h)
biblioteca	Imm32.lib
de DLL	Imm32.dll

Consulte também

CANDIDATELIST

do Gerenciador de Métodos de Entrada

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

Compartilhar via