Metode ITypeLib2::GetDocumentation2 (oaidl.h)

Artikel
02/29/2024

Mengambil string dokumentasi pustaka, 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]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

Parameter

[in] index

Indeks deskripsi jenis yang dokumentasinya akan dikembalikan. Jika indeks adalah -1, maka dokumentasi untuk pustaka dikembalikan.

[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 pemanggil tidak memerlukan konteks Bantuan, maka itu bisa null.

[out] pbstrHelpStringDll

Nama file yang sepenuhnya memenuhi syarat yang berisi DLL yang digunakan untuk file Bantuan. Jika pemanggil tidak memerlukan nama file, maka 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.
STG_E_INSUFFICIENTMEMORY	Tidak cukup memori untuk menyelesaikan operasi.

Keterangan

Mendapatkan informasi di tingkat pustaka jenis. 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 menuguhkan ke metode GetDocumentation dan mengembalikan string dokumentasi terkait.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	oaidl.h

Lihat juga

ITypeLib2

Bagikan melalui