Función GetEnhMetaFileDescriptionA (wingdi.h)

La función GetEnhMetaFileDescription recupera una descripción de texto opcional de un metarchivo de formato mejorado y copia la cadena en el búfer especificado.

Sintaxis

UINT GetEnhMetaFileDescriptionA(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPSTR        lpDescription
);

Parámetros

[in] hemf

Identificador del metarchivo mejorado.

[in] cchBuffer

Tamaño, en caracteres, del búfer para recibir los datos. Solo se copiarán estos muchos caracteres.

[out] lpDescription

Puntero a un búfer que recibe la descripción de texto opcional.

Valor devuelto

Si existe la descripción de texto opcional y el puntero del búfer es NULL, el valor devuelto es la longitud de la cadena de texto, en caracteres.

Si existe la descripción de texto opcional y el puntero del búfer es un puntero válido, el valor devuelto es el número de caracteres copiados en el búfer.

Si la descripción de texto opcional no existe, el valor devuelto es cero.

Si se produce un error en la función, se GDI_ERROR el valor devuelto.

Observaciones

La descripción del texto opcional contiene dos cadenas, la primera que identifica la aplicación que creó el metarchivo mejorado y la segunda que identifica la imagen contenida en el metarchivo. Las cadenas están separadas por un carácter NULL y terminan con dos caracteres NULL, por ejemplo, "XYZ Graphics Editor\0Bald Eagle\0\0" donde \0 representa el carácter NULL.

Donde los argumentos de texto deben usar caracteres Unicode, use esta función como una función de caracteres anchos. Donde los argumentos de texto deben usar caracteres del conjunto de caracteres de Windows, use esta función como una función ANSI.

Nota

El encabezado wingdi.h define GetEnhMetaFileDescription 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	wingdi.h (incluya Windows.h)
biblioteca de	Gdi32.lib
DLL de	Gdi32.dll

Consulte también

CreateEnhMetaFile

funciones de metarchivo de

introducción a los metarchivos de