Função ImmGetGuideLineA (imm.h)
Recupera informações sobre erros. Os aplicativos usam as informações para notificações do usuário.
Sintaxe
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR 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.
[out, optional] lpBuf
Ponteiro para um buffer no qual a função recupera a cadeia de caracteres de mensagem de erro. Esse parâmetro contém NULL se dwIndex não estiver 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 encerramento.
Valor de retorno
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 seguintes valores.
| 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 seguintes valores.
| 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 encontrar 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 de 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 a 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 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.
Observações
Os aplicativos normalmente chamam essa função depois de receber um comando IMN_GUIDELINE.
Nota
O cabeçalho imm.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 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 |