Compartilhar via


Função ImmGetGuideLineW (immdev.h)

Recupera informações sobre erros. Os aplicativos usam as informações para notificações do usuário.

Sintaxe

DWORD ImmGetGuideLineW(
  [in]            HIMC   unnamedParam1,
  [in]            DWORD  dwIndex,
  [out, optional] LPWSTR lpBuf,
  [in]            DWORD  dwBufLen
);

Parâmetros

[in] unnamedParam1

Manipule para o contexto de entrada.

[in] dwIndex

Tipo de informações de diretriz a serem recuperadas. Esse parâmetro pode ter um dos valores a seguir.

Valor Significado
GGL_LEVEL
Retornar o nível de erro.
GGL_INDEX
Retornar o índice de erro.
GGL_STRING
Retornar a cadeia de caracteres da mensagem de erro.
GGL_PRIVATE
Retornar informações sobre a conversão inversa.

[out, optional] lpBuf

Ponteiro para um buffer no qual a função recupera a cadeia de caracteres de mensagem de erro. Esse parâmetro conterá NULL se dwIndex não for GGL_STRING ou GGL_PRIVATE ou se dwBufLen estiver definido como 0.

[in] dwBufLen

Tamanho, em bytes, 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 receber a cadeia de caracteres de mensagem de erro, não incluindo o caractere nulo de terminação.

Retornar valor

Retorna um nível de erro, um índice de erro ou o tamanho de uma cadeia de caracteres de mensagem de erro, dependendo do valor do parâmetro dwIndex . Se dwIndex for GGL_LEVEL, o retorno será um dos valores a seguir.

Valor Significado
GL_LEVEL_ERROR Erro. O IME pode não ser capaz de continuar.
GL_LEVEL_FATAL Erro fatal. O IME não pode continuar e os dados podem ser perdidos.
GL_LEVEL_INFORMATION Nenhum erro. As informações estão disponíveis para o usuário.
GL_LEVEL_NOGUIDELINE Nenhum erro. Remova a mensagem de erro anterior se ainda estiver visível.
GL_LEVEL_WARNING Entrada inesperada ou outro resultado. O usuário deve ser avisado, mas o IME pode continuar.
 

Se dwIndex for GGL_INDEX, o valor retornado será um dos valores a seguir.

Valor Significado
GL_ID_CANNOTSAVE O dicionário ou os dados de estatísticas não podem ser salvos.
GL_ID_NOCONVERT O IME não pode mais converter.
GL_ID_NODICTIONARY O IME não pode localizar o dicionário ou o dicionário tem um formato inesperado.
GL_ID_NOMODULE O IME não pode localizar o módulo necessário.
GL_ID_READINGCONFLICT Ocorreu um conflito de leitura. Por exemplo, algumas vogais não podem ser montadas para formar um caractere.
GL_ID_TOOMANYSTROKE Há muitos traços para um caractere ou uma cláusula.
GL_ID_TYPINGERROR Erro de digitação. O IME não pode lidar com essa digitação.
GL_ID_UNKNOWN Erro desconhecido. Consulte a cadeia de caracteres da mensagem de erro.
GL_ID_INPUTREADING O IME está aceitando a entrada de caractere de leitura do usuário final.
GL_ID_INPUTRADICAL O IME está aceitando entrada de caractere radical do usuário final.
GL_ID_INPUTCODE O IME está aceitando a entrada de código de caractere do usuário final.
GL_ID_CHOOSECANDIDATE O IME está aceitando a seleção de cadeia de caracteres candidata do usuário final.
GL_ID_REVERSECONVERSION Informações sobre conversão reversa estão disponíveis chamando ImmGetGuideLine, especificando GGL_PRIVATE. As informações recuperadas estão no formato CANDIDATELIST .
 

Se dwIndex for GGL_STRING, o valor retornado será o número de bytes da cadeia de caracteres copiada para o buffer. No entanto, se dwBufLen for 0, o valor retornado será o tamanho do buffer necessário para receber a cadeia de caracteres, não incluindo o caractere nulo de terminação. Para Unicode, se dwBufLen for 0, o valor retornado será o tamanho, em bytes que não incluem o caractere nulo de terminação Unicode.

Se dwIndex for GGL_PRIVATE, o valor retornado será o número de bytes de informações copiadas para o buffer. Se dwIndex for GGL_PRIVATE e dwBufLen for 0, o valor retornado será o tamanho do buffer necessário para receber as informações.

Comentários

Os aplicativos normalmente chamam essa função depois de receber um comando IMN_GUIDELINE .

Observação

O cabeçalho immdev.h define ImmGetGuideLine 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

IMN_GUIDELINE

Gerenciador de Métodos de Entrada

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