Metode ITypeInfo2::GetDocumentation2 (oaidl.h)

Mengambil string dokumentasi, nama dan jalur file Bantuan lengkap, konteks pelokalan yang akan digunakan, dan ID konteks untuk topik Bantuan pustaka dalam file Bantuan.

Sintaks

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

Parameter

[in] memid

Pengidentifikasi anggota untuk deskripsi jenis.

[in] lcid

Pengidentifikasi lokal.

[out] pbstrHelpString

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

[out] pdwHelpStringContext

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

[out] pbstrHelpStringDll

Nama file yang sepenuhnya memenuhi syarat yang berisi DLL yang digunakan untuk file Bantuan. Jika penelepon 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

Mendapatkan informasi di tingkat informasi jenis (tentang informasi jenis dan anggotanya). Pemanggil harus membebaskan parameter BSTR.

Fungsi ini akan memanggil _DLLGetDocumentation di DLL yang ditentukan untuk mengambil string Bantuan yang diinginkan, jika ada konteks string Bantuan untuk item ini. Jika tidak ada konteks string Bantuan atau terjadi kesalahan, maka itu akan menangguhkan ke metode GetDocumentation dan mengembalikan string dokumentasi terkait.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	oaidl.h

Lihat juga

ITypeInfo2