Função ImmGetDescriptionA (imm.h)

Copia a descrição do IME para o buffer especificado.

Sintaxe

UINT ImmGetDescriptionA(
                  HKL   unnamedParam1,
  [out, optional] LPSTR lpszDescription,
  [in]            UINT  uBufLen
);

Parâmetros

unnamedParam1

[out, optional] lpszDescription

Ponteiro para um buffer no qual a função recupera a cadeia de caracteres terminada em nulo que descreve o IME.

[in] uBufLen

Tamanho, em caracteres, do buffer de saída. O aplicativo define esse parâmetro como 0 se a função deve retornar o tamanho do buffer necessário para a descrição completa, excluindo o caractere nulo de encerramento.

Windows NT, Windows 2000, Windows XP: O tamanho do buffer está em caracteres Unicode, cada um consistindo em dois bytes. Se o parâmetro for definido como 0, a função retornará o tamanho do buffer necessário em caracteres Unicode, excluindo o caractere nulo de terminação Unicode.

Valor de retorno

Retorna o número de caracteres copiados para o buffer de saída. Se o aplicativo definir o parâmetro uBufLen como 0, a função retornará o tamanho do buffer necessário para receber a descrição. Nenhum dos valores inclui o caractere nulo de encerramento. Para Unicode, a função retorna o número de caracteres Unicode, não incluindo o caractere nulo de terminação Unicode.

Observações

Nota

O cabeçalho imm.h define ImmGetDescription 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 ao idioma do Leste Asiático instalado., suporte ao idioma 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

do Gerenciador de Métodos de Entrada

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