ITypeInfo：：GetDocumentation 方法 (oaidl.h)

  • 發行項

擷取文件字串、完整的說明檔名稱和路徑，以及指定類型描述之說明主題的主題代碼。

語法

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。

傳回值

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

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

備註

GetDocumentation 函式可讓您存取 memid 參數所指定成員的檔。 如果傳入 的 memid 是MEMBERID_NIL，則會傳回類型描述的檔。

如果類型描述繼承自另一個類型描述，則此函式會視需要遞歸至基底類型描述，以尋找具有要求成員標識符的專案。

呼叫端應該使用 SysFreeString 來釋放 pBstrName、 pBstrDocString 和 pBstrHelpFile 所參考的 BSTR。

規格需求

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

另請參閱

ITypeInfo