ITypeLib：：GetDocumentation 方法 (oaidl.h)

  • 项目

检索库的文档字符串、完整的帮助文件名和路径，以及帮助文件中库帮助主题的上下文标识符。

语法

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

参数

[in] index

要返回其文档的类型说明的索引。 如果 index 为 -1，则返回库本身的文档。

[out] pBstrName

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

[out] pBstrDocString

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

[out] pdwHelpContext

与指定项关联的帮助上下文标识符 (ID) 。 如果调用方不需要帮助上下文 ID，则 pdwHelpContext 可以为 null。

[out] pBstrHelpFile

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

返回值

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

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

注解

调用方应释放 参数 pBstrName、 pBstrDocString 和 pBstrHelpFile。

要求

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

另请参阅

ITypeLib