Função ImmGetDescriptionW (immdev.h)

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

Sintaxe

UINT ImmGetDescriptionW(
                  HKL    unnamedParam1,
  [out, optional] LPWSTR 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 terminação.

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.

Retornar valor

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 terminação. Para Unicode, a função retorna o número de caracteres Unicode, sem incluir o caractere nulo de terminação Unicode.

Comentários

Observação

O cabeçalho immdev.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 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 a idioma do Leste Asiático instalado., 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

Gerenciador de Métodos de Entrada

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