helpstring 属性

[helpstring] 属性指定一个字符串，该字符串用于描述应用它的元素。 可以将 [helpstring] 属性应用于库、importlib、interface、dispinterface、module 或 coclass 语句、typedef、属性和方法。

[
    helpstring(help-text-string)
    [, optional-attribute-list]
] 
element element-name
{
    definition
}

[idl-statement, helpstring(help-text-string)]

参数

help-text-string

包含帮助文本的以零结尾的字符串。

optional-attribute-list

零个或多个 MIDL 属性语句。

element

以下指令之一： library、 [importlib]、 interface、 dispinterface、 module、 typedef、 method、 property 或 coclass。

element-name

其他软件组件可用于描述当前元素的名称

definition

指定构成元素定义的语句。

idl-statement

MIDL 接口定义语句，例如 propget 或 propput。

备注

使用 ITypeLib 和 ITypeInfo 接口中的 GetDocumentation 函数检索帮助字符串。

示例

[
    uuid(1e196b20-1f3c-1069-996b-00dd010fe676),
    helpstring("Lines 1.0 Type Library"),
    version(1.0)
]
library Lines
{
     [
         uuid(1e123456-1f3c-1069-996b-00dd010fe676), 
         helpstring("Line object."),
         oleautomation,
         dual
     ]
     interface ILine : IDispatch                         
     {
         [propget, helpstring("Returns and sets RGB color.")]
         HRESULT Color([out, retval] long* ReturnVal); 
         [propput, helpstring("Returns and sets RGB color.")]
         HRESULT Color([in] long rgb);
     }
};

另请参阅

图书馆

importlib

接口

dispinterface

模块

coclass

typedef

ODL 文件语法

ODL 文件示例

使用 MIDL 生成类型库