Función ImmGetCompositionStringA (imm.h)
Recupera información sobre la cadena de composición.
Sintaxis
LONG ImmGetCompositionStringA(
HIMC unnamedParam1,
DWORD unnamedParam2,
[out, optional] LPVOID lpBuf,
[in] DWORD dwBufLen
);
Parámetros
unnamedParam1
unnamedParam2
[out, optional] lpBuf
Puntero a un búfer en el que la función recupera la información de la cadena de composición.
[in] dwBufLen
Tamaño, en bytes, del búfer de salida, incluso si la salida es una cadena Unicode. La aplicación establece este parámetro en 0 si la función va a devolver el tamaño del búfer de salida necesario.
Valor devuelto
Devuelve el número de bytes copiados en el búfer de salida. Si dwBufLen se establece en 0, la función devuelve el tamaño del búfer, en bytes, necesario para recibir toda la información solicitada, excepto el carácter nulo de terminación. El valor devuelto es siempre el tamaño, en bytes, incluso si los datos solicitados son una cadena Unicode.
Esta función devuelve uno de los siguientes códigos de error negativos si no se realiza correctamente:
- IMM_ERROR_NODATA. Los datos de composición no están listos en el contexto de entrada.
- IMM_ERROR_GENERAL. Error general detectado por IME.
Comentarios
Una aplicación llama a esta función en respuesta al mensaje WM_IME_COMPOSITION o WM_IME_STARTCOMPOSITION . IMM quita la información cuando la aplicación llama a la función ImmReleaseContext .
Nota
El encabezado imm.h define ImmGetCompositionString 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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 |
Consulte también
Administrador de métodos de entrada