通过

iTypeInfo：：GetDocumentation 方法 (oaidl.h)

  • 项目

从文档字符串、完整的帮助文件名和路径以及帮助主题的上下文 ID 中检索指定的类型说明。

语法

HRESULT GetDocumentation(
  [in]  MEMBERID memid,
  [out] BSTR     *pBstrName,
  [out] BSTR     *pBstrDocString,
  [out] DWORD    *pdwHelpContext,
  [out] BSTR     *pBstrHelpFile
);

参数

[in] memid

要返回其文档的成员的 ID。

[out] pBstrName

指定项的名称。 如果调用方不需要项名称， 则 pBstrName 可以为 null。

[out] pBstrDocString

指定项的文档字符串。 如果调用方不需要文档字符串， 则 pBstrDocString 可以为 null。

[out] pdwHelpContext

帮助本地化上下文。 如果调用方不需要帮助上下文，它可以为 null。

[out] pBstrHelpFile

包含用于帮助文件的 DLL 的文件的完全限定名称。 如果调用方不需要文件名，则可以为 null。

返回值

此方法可以返回其中一个值。

返回代码 说明
S_OK
成功。
E_INVALIDARG
一个或多个参数无效。
E_OUTOFMEMORY
内存不足，无法完成操作。

注解

函数 GetDocumentation 提供对 memid 参数所指定成员的文档的访问权限。 如果传入的 memid MEMBERID_NIL，则返回类型说明的文档。

如果类型说明继承自另一个类型说明，则此函数将递归到基类型说明（如有必要）以查找具有所请求成员 ID 的项。

调用方应使用 SysFreeString 释放 pBstrName、 pBstrDocString 和 pBstrHelpFile 引用的 BSTR。

要求

要求 值
目标平台 Windows
标头 oaidl.h

另请参阅

ITypeInfo