ITypeInfo2::GetDocumentation2 方法 (oaidl.h)

抓取文件字串、完整「說明」檔案名稱與路徑、要使用的當地語系化內容,以及「說明」檔案中「說明」主題庫的內容識別碼。

語法

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

參數

[in] memid

型別描述的成員識別項。

[in] lcid

地區設定識別碼。

[out] pbstrHelpString

指定項目的名稱。 如果呼叫端不需要項目名稱, 則 pbstrHelpString 可以是 Null。

[out] pdwHelpStringContext

說明本地化內容。 如果呼叫端不需要 [說明] 內容,它可以是 Null。

[out] pbstrHelpStringDll

檔案的完整名稱,其中包含用於說明檔的 DLL。 如果呼叫端不需要檔名,它可以是 Null。

傳回值

這個方法可以傳回其中一個值。

傳回碼 Description
S_OK
成功。
E_INVALIDARG
一或多個自變數無效。
E_OUTOFMEMORY
記憶體不足,無法完成作業。

備註

取得類型資訊層級的資訊, (類型資訊及其成員) 。 呼叫端應該釋放 BSTR 參數。

如果這個專案有說明字串內容,此函式會呼叫指定 DLL 中的 _DLLGetDocumentation ,以擷取所需的說明字串。 如果沒有說明字串內容或發生錯誤,則會延遲 GetDocumentation 方法並傳回相關聯的檔字串。

規格需求

需求
目標平台 Windows
標頭 oaidl.h

另請參閱

ITypeInfo2