Función ImmGetGuideLineA (imm.h)
Recupera información sobre los errores. Las aplicaciones usan la información para las notificaciones de usuario.
Sintaxis
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR lpBuf,
[in] DWORD dwBufLen
);
Parámetros
[in] unnamedParam1
Identificador del contexto de entrada.
[in] dwIndex
Tipo de información de directrices que se va a recuperar. Este parámetro puede tener uno de los valores siguientes.
[out, optional] lpBuf
Puntero a un búfer en el que la función recupera la cadena del mensaje de error. Este parámetro contiene NULL si dwIndex no es GGL_STRING o GGL_PRIVATE o si dwBufLen está establecido en 0.
[in] dwBufLen
Tamaño, en bytes, del búfer de salida. La aplicación establece este parámetro en 0 si la función es devolver el tamaño del búfer necesario para recibir la cadena del mensaje de error, sin incluir el carácter nulo de terminación.
Valor devuelto
Devuelve un nivel de error, un índice de error o el tamaño de una cadena de mensaje de error, según el valor del parámetro dwIndex . Si dwIndex es GGL_LEVEL, el valor devuelto es uno de los siguientes valores.
| Valor | Significado |
|---|---|
| GL_LEVEL_ERROR | Error. Es posible que el IME no pueda continuar. |
| GL_LEVEL_FATAL | Error irrecuperable. El IME no puede continuar y es posible que se pierdan los datos. |
| GL_LEVEL_INFORMATION | Sin errores. La información está disponible para el usuario. |
| GL_LEVEL_NOGUIDELINE | Sin errores. Quite el mensaje de error anterior si sigue visible. |
| GL_LEVEL_WARNING | Entrada inesperada u otro resultado. Se debe advertir al usuario, pero el IME puede continuar. |
Si dwIndex es GGL_INDEX, el valor devuelto es uno de los valores siguientes.
| Valor | Significado |
|---|---|
| GL_ID_CANNOTSAVE | El diccionario o los datos de estadísticas no se pueden guardar. |
| GL_ID_NOCONVERT | El IME no puede convertir más. |
| GL_ID_NODICTIONARY | El IME no encuentra el diccionario o el diccionario tiene un formato inesperado. |
| GL_ID_NOMODULE | El IME no encuentra el módulo necesario. |
| GL_ID_READINGCONFLICT | Se produjo un conflicto de lectura. Por ejemplo, algunas vocales no se pueden juntar para formar un carácter. |
| GL_ID_TOOMANYSTROKE | Hay demasiados trazos para un carácter o una cláusula. |
| GL_ID_TYPINGERROR | Error de escritura. El IME no puede controlar esta escritura. |
| GL_ID_UNKNOWN | Error desconocido. Consulte la cadena del mensaje de error. |
| GL_ID_INPUTREADING | El IME acepta la entrada de caracteres de lectura del usuario final. |
| GL_ID_INPUTRADICAL | El IME acepta la entrada de caracteres radical del usuario final. |
| GL_ID_INPUTCODE | El IME acepta la entrada de código de caracteres del usuario final. |
| GL_ID_CHOOSECANDIDATE | El IME acepta la selección de cadenas candidatas del usuario final. |
| GL_ID_REVERSECONVERSION | La información sobre la conversión inversa está disponible mediante una llamada a ImmGetGuideLine, especificando GGL_PRIVATE. La información recuperada está en formato CANDIDATELIST . |
Si dwIndex está GGL_STRING, el valor devuelto es el número de bytes de la cadena copiada en el búfer. Sin embargo, si dwBufLen es 0, el valor devuelto es el tamaño de búfer necesario para recibir la cadena, sin incluir el carácter nulo de terminación. En el caso de Unicode, si dwBufLen es 0, el valor devuelto es el tamaño, en bytes que no incluyen el carácter NULO de terminación Unicode.
Si dwIndex es GGL_PRIVATE, el valor devuelto es el número de bytes de información copiada en el búfer. Si dwIndex es GGL_PRIVATE y dwBufLen es 0, el valor devuelto es el tamaño del búfer necesario para recibir la información.
Comentarios
Las aplicaciones suelen llamar a esta función después de recibir un comando IMN_GUIDELINE .
Nota
El encabezado imm.h define ImmGetGuideLine como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Windows XP [solo aplicaciones de escritorio],compatibilidad con idiomas del Este asiático instaladas. |
| Servidor mínimo compatible | Windows Server 2003 [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | imm.h (incluya Immdev.h, Windows.h) |
| Library | Imm32.lib |
| Archivo DLL | Imm32.dll |