通过

iTypeLib2：：GetDocumentation2 方法 (oaidl.h)

  • 项目

检索库的文档字符串、完整的帮助文件名称和路径、要使用的本地化上下文以及帮助文件中库帮助主题的上下文 ID。

语法

HRESULT GetDocumentation2(
  [in]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

参数

[in] index

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

[in] lcid

区域设置标识符。

[out] pbstrHelpString

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

[out] pdwHelpStringContext

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

[out] pbstrHelpStringDll

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

返回值

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

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

注解

获取类型库级别的信息。 调用方应释放 BSTR 参数。

如果存在此项的帮助字符串上下文，此函数将调用指定 DLL 中的 _DLLGetDocumentation 来检索所需的帮助字符串。 如果帮助字符串上下文不存在或发生错误，它将遵循 GetDocumentation 方法并返回关联的文档字符串。

要求

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

另请参阅

ITypeLib2