helpstring 属性

[helpstring] 属性は、適用する要素を記述するために使用される文字列を指定します。 [helpstring] 属性は、library、importlib、interface、dispinterface、module、または coclass ステートメント、typedefs、properties、および method に適用できます。

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

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

パラメーター

help-text-string

ヘルプ テキストを含む文字の 0 で終わる文字列。

optional-attribute-list

0 個以上の MIDL 属性ステートメント。

element

次のいずれかのディレクティブ: library、[importlib]、interface、dispinterface、module、typedef、method、property、または coclass。

element-name

他のソフトウェア コンポーネントが現在の要素を示すために使用できる名前

definition

要素定義を構成するステートメントを指定します。

idl-statement

propget や propput などの MIDL インターフェイス定義ステートメント。

解説

ヘルプ文字列を取得するには、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

インターフェイス

ディスパッチ

モジュール

coclass

Typedef

ODL ファイルの構文

ODL ファイルの例

MIDL を使用したタイプ ライブラリの生成