勇芳软件工作室.汉化:  Metafiles > Metafile Functions >

GetEnhMetaFileDescription

Previous pageReturn to chapter overviewNext page

描述

 

GetEnhMetaFileDescription功能从增强格式的图元文件中检索可选的文本描述,并将该字符串复制到指定的缓冲区。

 

C++ 语法

 

UINT GetEnhMetaFileDescription(

__in  HENHMETAFILE hemf,

__in  UINT cchBuffer,

__out LPTSTR lpszDescription

);

 

PowerBASIC 语法

 

FUNCTION GetEnhMetaFileDescriptionA ( _

BYVAL hemf AS DWORD, _

BYVAL cchBuffer AS DWORD, _

BYREF lpszDescription AS ASCIIZ _

) AS DWORD

 

Unicode版本:

 

FUNCTION GetEnhMetaFileDescriptionW ( _

BYVAL hemf AS DWORD, _

BYVAL cchBuffer AS DWORD, _

BYREF lpszDescription AS WSTRINGZ _

) AS DWORD

 

参数

 

hemf

 

[in]处理增强型图元文件。

 

cchBuffer

 

[in]指定接收数据的缓冲区的大小(以字符为单位)。只有这么多人物才会被复制。

 

lpszDescription

 

[out]指向接收可选文本描述的缓冲区的指针。

 

返回值

 

如果可选文本描述存在且缓冲区指针为NULL,则返回值为文本字符串的长度,以字符为单位。

 

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

 

如果可选文本描述不存在,返回值为零。

 

如果函数失败,返回值为GDI_ERROR。

 

备注

 

可选的文本描述包含两个字符串,第一个标识创建增强型图元文件的应用程序,第二个标识图元文件中包含的图片。字符串由空字符分隔,并以两个空字符结尾,例如“XYZ Graphics Editor \\ 0Bald Eagle \\ 0 \\ 0”,其中\\ 0表示空字符。

 

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

 

Windows 95/98 / Me:增强型图元文件的描述字符串的最大长度为16,384字节。

 

Windows 95/98 / Me:Microsoft Layer for Unicode支持GetEnhMetaFileDescriptionW.

 

引用文件 #INCLUDE Once

 

WinGdi.inc(包括Windows.inc)