ITypeInfo::Metode GetDocumentation (oaidl.h)

Artikel
02/29/2024

Mengambil string dokumentasi, nama dan jalur file Bantuan lengkap, dan ID konteks untuk topik Bantuan untuk deskripsi jenis tertentu.

Sintaks

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

Parameter

[in] memid

ID anggota yang dokumentasinya akan dikembalikan.

[out] pBstrName

Nama item yang ditentukan. Jika pemanggil tidak memerlukan nama item, pBstrName bisa null.

[out] pBstrDocString

String dokumentasi untuk item yang ditentukan. Jika pemanggil tidak memerlukan string dokumentasi, pBstrDocString bisa null.

[out] pdwHelpContext

Konteks pelokalan Bantuan. Jika pemanggil tidak memerlukan konteks Bantuan, itu bisa null.

[out] pBstrHelpFile

Nama file yang sepenuhnya memenuhi syarat yang berisi DLL yang digunakan untuk file Bantuan. Jika pemanggil tidak memerlukan nama file, itu bisa null.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
S_OK	Berhasil.
E_INVALIDARG	Satu atau beberapa argumen tidak valid.
E_OUTOFMEMORY	Tidak cukup memori untuk menyelesaikan operasi.

Keterangan

Fungsi GetDocumentation menyediakan akses ke dokumentasi untuk anggota yang ditentukan oleh parameter memid . Jika memid yang diteruskan MEMBERID_NIL, maka dokumentasi untuk deskripsi jenis dikembalikan.

Jika deskripsi jenis mewarisi dari deskripsi jenis lain, fungsi ini rekursif ke deskripsi jenis dasar, jika perlu, untuk menemukan item dengan ID anggota yang diminta.

Pemanggil harus menggunakan SysFreeString untuk membebaskan BSTR yang direferensikan oleh pBstrName, pBstrDocString, dan pBstrHelpFile.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	oaidl.h

Lihat juga

ITypeInfo

Bagikan melalui