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

Статья
11/20/2024

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

Синтаксис

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

Параметры

[in] hemf

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

[in] cchBuffer

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

[out] lpDescription

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

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

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

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

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

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

Замечания

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

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	wingdi.h (включая Windows.h)
библиотеки	Gdi32.lib
DLL	Gdi32.dll

См. также

CreateEnhMetaFile

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

Обзор метафайлов

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