getEnhMetaFileDescriptionW 函数 (wingdi.h)

  • 项目

GetEnhMetaFileDescription 函数从增强格式的图元文件中检索可选文本说明，并将字符串复制到指定的缓冲区。

语法

UINT GetEnhMetaFileDescriptionW(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPWSTR       lpDescription
);

参数

[in] hemf

增强型图元文件的句柄。

[in] cchBuffer

要接收数据的缓冲区的大小（以字符为单位）。 仅复制这么多字符。

[out] lpDescription

指向接收可选文本说明的缓冲区的指针。

返回值

如果存在可选文本说明，并且缓冲区指针为 NULL，则返回值为文本字符串的长度（以字符为单位）。

如果存在可选文本说明，并且缓冲区指针是有效的指针，则返回值是复制到缓冲区中的字符数。

如果可选文本说明不存在，则返回值为零。

如果函数失败，则返回值GDI_ERROR。

注解

可选文本说明包含两个字符串，第一个字符串标识创建增强型图元文件的应用程序，第二个字符串标识图元文件中包含的图片。 字符串由空字符分隔，以两个空字符结尾，例如，“XYZ 图形编辑器\0Bald Eagle\0\0”，其中 \0 表示空字符。

如果文本参数必须使用 Unicode 字符，请使用此函数作为宽字符函数。 如果文本参数必须使用 Windows 字符集中的字符，请使用此函数作为 ANSI 函数。

注意

wingdi.h 标头将 GetEnhMetaFileDescription 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 wingdi.h (包括 Windows.h)
Library Gdi32.lib
DLL Gdi32.dll

另请参阅

CreateEnhMetaFile

图元文件函数

图元文件概述