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

說明內容標識碼 (標識碼) 與指定的專案相關聯。 如果呼叫端不需要說明內容標識符， 則 pdwHelpContext 可以是 null。

[out] pBstrHelpFile

說明檔的完整名稱。 如果呼叫端不需要說明檔名， 則 pBstrHelpFile 可以是 null。

傳回值

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

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

備註

呼叫端應該釋放 pBstrName、 pBstrDocString 和 pBstrHelpFile 參數。

規格需求

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

另請參閱

ITypeLib