Поделиться через


Функция GetEnhMetaFileDescriptionA (wingdi.h)

Функция GetEnhMetaFileDescription извлекает необязательное текстовое описание из метафайла расширенного формата и копирует строку в указанный буфер.

Синтаксис

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

Параметры

[in] hemf

Дескриптор расширенного метафайла.

[in] cchBuffer

Размер (в символах) буфера для получения данных. Будет скопировано только это количество символов.

[out] lpDescription

Указатель на буфер, получающий необязательное текстовое описание.

Возвращаемое значение

Если необязательное текстовое описание существует, а указатель буфера имеет значение NULL, возвращаемое значение — это длина текстовой строки в символах.

Если существует необязательное текстовое описание и указатель буфера является допустимым указателем, то возвращаемое значение — это количество символов, скопированных в буфер.

Если необязательное текстовое описание не существует, возвращаемое значение равно нулю.

Если функция завершается сбоем, возвращаемое значение будет GDI_ERROR.

Комментарии

Необязательное текстовое описание содержит две строки: первая идентифицирует приложение, создающее расширенный метафайл, а вторая — изображение, содержащееся в метафайле. Строки разделяются символом NULL и заканчиваются двумя символами NULL, например "XYZ Graphics Editor\0Bald Eagle\0\0", где \0 представляет символ NULL.

Если текстовые аргументы должны использовать символы Юникода, используйте эту функцию как функцию расширенных символов. Если текстовые аргументы должны использовать символы из кодировки Windows, используйте эту функцию как функцию ANSI.

Примечание

Заголовок wingdi.h определяет GetEnhMetaFileDescription в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

   
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header wingdi.h (включая Windows.h)
Библиотека Gdi32.lib
DLL Gdi32.dll

См. также раздел

CreateEnhMetaFile

Функции метафайлов

Общие сведения о метафайлах