Función ImmGetDescriptionA (imm.h)

Copia la descripción del IME en el búfer especificado.

Sintaxis

UINT ImmGetDescriptionA(
                  HKL   unnamedParam1,
  [out, optional] LPSTR lpszDescription,
  [in]            UINT  uBufLen
);

Parámetros

unnamedParam1

[out, optional] lpszDescription

Puntero a un búfer en el que la función recupera la cadena terminada en null que describe el IME.

[in] uBufLen

Tamaño, en caracteres, del búfer de salida. La aplicación establece este parámetro en 0 si la función devuelve el tamaño del búfer necesario para la descripción completa, excepto el carácter nulo de terminación.

Windows NT, Windows 2000, Windows XP: El tamaño del búfer está en caracteres Unicode, cada uno de los cuales consta de dos bytes. Si el parámetro se establece en 0, la función devuelve el tamaño del búfer necesario en caracteres Unicode, excepto el carácter Null de terminación Unicode.

Valor devuelto

Devuelve el número de caracteres copiados en el búfer de salida. Si la aplicación establece el parámetro uBufLen en 0, la función devuelve el tamaño del búfer necesario para recibir la descripción. Ninguno de los valores incluye el carácter nulo de terminación. Para Unicode, la función devuelve el número de caracteres Unicode, no incluido el carácter NULL de terminación Unicode.

Comentarios

Nota:

El encabezado imm.h define ImmGetDescription 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

Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio],compatibilidad con idiomas del Este asiático instalada., compatibilidad con idiomas del Este asiático instalada.
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

Funciones del Administrador de métodos de entrada