Função ImmGetCompositionStringA (imm.h)

  • Artigo

Recupera informações sobre a cadeia de caracteres de composição.

Sintaxe

LONG ImmGetCompositionStringA(
                  HIMC   unnamedParam1,
                  DWORD  unnamedParam2,
  [out, optional] LPVOID lpBuf,
  [in]            DWORD  dwBufLen
);

Parâmetros

unnamedParam1

unnamedParam2

[out, optional] lpBuf

Ponteiro para um buffer no qual a função recupera as informações da cadeia de caracteres de composição.

[in] dwBufLen

Tamanho, em bytes, do buffer de saída, mesmo que a saída seja uma cadeia de caracteres Unicode. O aplicativo define esse parâmetro como 0 se a função deve retornar o tamanho do buffer de saída necessário.

Retornar valor

Retorna o número de bytes copiados para o buffer de saída. Se dwBufLen estiver definido como 0, a função retornará o tamanho do buffer, em bytes, necessário para receber todas as informações solicitadas, excluindo o caractere nulo de terminação. O valor retornado é sempre o tamanho, em bytes, mesmo que os dados solicitados sejam uma cadeia de caracteres Unicode.

Essa função retornará um dos seguintes códigos de erro negativos se não tiver êxito:

  • IMM_ERROR_NODATA. Os dados de composição não estão prontos no contexto de entrada.
  • IMM_ERROR_GENERAL. Erro geral detectado pelo IME.

Comentários

Um aplicativo chama essa função em resposta à mensagem WM_IME_COMPOSITION ou WM_IME_STARTCOMPOSITION . O IMM remove as informações quando o aplicativo chama a função ImmReleaseContext .

Nota Você deve escrever código para lidar com Hiragana de largura total e Katakana de meia largura se o aplicativo for usado com o SIP (Painel de Entrada Flexível).
 

Observação

O cabeçalho imm.h define ImmGetCompositionString 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 imm.h (inclua Immdev.h, Windows.h)
Biblioteca Imm32.lib
DLL Imm32.dll

Confira também

ImmReleaseContext

Gerenciador de Métodos de Entrada

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

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION