IDisplayHelp::Metode ShowTopic (mmc.h)

Metode IDisplayHelp::ShowTopic menampilkan topik Bantuan HTML yang ditentukan dalam file Bantuan HTML MMC yang digabungkan.

Sintaks

HRESULT ShowTopic(
  [in] LPOLESTR pszHelpTopic
);

Parameter

[in] pszHelpTopic

Penunjuk ke string yang dihentikan NULL yang menentukan topik yang akan ditampilkan dalam file Bantuan HTML MMC yang digabungkan. String harus memiliki format berikut:

helpfilename::topicfilename

di mana helpfilename adalah nama file dari file Bantuan HTML snap-in (.chm) yang digabungkan MMC ke dalam file kumpulan Bantuan HTML MMC (ini adalah nama file saja, bukan jalur ke file Bantuan HTML asli), dan topicfilename adalah jalur internal ke file topik dalam file .chm snap-in. Penulis file Bantuan HTML snap-in menentukan apakah ada struktur direktori internal untuk file HTML topik atau jika semua file HTML topik berada di akar file .chm.

Snap-in memberi tahu MMC tentang file .chm-nya dalam implementasi metode ISnapinHelp2::GetHelpTopic .

Misalnya, jika snap-in memiliki file Bantuan HTML mysnapin.chm yang digabungkan ke dalam file kumpulan Bantuan HTML MMC, dan file HTML topik yang memiliki jalur file internal htm/help01.htm, string akan memiliki formulir berikut:

mysnapin.chm::htm/help01.htm

Jika sebaliknya file topik help01.htm berada di akar file Bantuan mysnapin.chm, string harus memiliki formulir berikut:

mysnapin.chm::/help01.htm

Dukungan untuk ID numerik untuk topik tidak disertakan dalam versi 1.2 dan yang lebih lama.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Keterangan

MMC versi 1.0 dan 1.1 mengharuskan pszHelpTopic dialokasikan dengan fungsi COM API CoTaskMemAlloc, dan MMC kemudian akan membebaskan string. Ini melanggar aturan COM untuk alokasi dalam parameter, yang mengharuskan mereka dialokasikan dan dibebaskan oleh pemanggil (snap-in). Dalam MMC 1.2 dan MMC 2.0, tidak lagi diperlukan bahwa pszHelpTopic dialokasikan dengan CoTaskMemAlloc. Pemanggil bebas menggunakan manajemen memori apa pun yang diinginkannya. Jika penelepon memilih untuk menggunakan CoTaskMemAlloc, pemanggil juga bertanggung jawab untuk memanggil CoTaskMemFree untuk membebaskan string.

Snap-in dapat memberikan bantuan konteks untuk item yang dipilih dengan menangani pemberitahuan MMCN_CONTEXTHELP dalam metode IComponent::Notify dan memanggil IDisplayHelp::ShowTopic.

Untuk halaman properti, snap-in harus memanggil MMCPropertyHelp alih-alih IDisplayHelp::ShowTopic. Karena lembar properti MMC biasanya berjalan pada utas terpisah, halaman properti tidak dapat menggunakan antarmuka IDisplayHelp secara langsung. Sebagai gantinya, halaman properti dapat memanggil MMCPropertyHelp dari pustaka MMC untuk mencapai hasil yang sama. MMCPropertyHelp mengambil parameter string topik yang sama dengan IDisplayHelp::ShowTopic dan menangani marshalling permintaan ke utas MMC utama.

Jika snap-in menangani pemberitahuan MMCN_CONTEXTHELP , MMC mengharapkan snap-in untuk menentukan topik Bantuan untuk item yang dipilih. Akibatnya, dalam penangan pemberitahuan untuk pemberitahuan MMCN_CONTEXTHELP , snap-in memiliki dua opsi:

• Ini dapat memanggil IDisplayHelp::ShowTopic atau MMCPropertyHelp untuk menentukan topik Bantuan lalu mengembalikan S_OK untuk menunjukkan keberhasilan. Ketahuilah bahwa snap-in hanya boleh mengembalikan S_OK jika menentukan topik Bantuan. Jika snap-in mengembalikan S_OK tanpa menentukan topik Bantuan, tidak ada topik Bantuan yang akan ditampilkan.
• Ini dapat mengembalikan S_FALSE ke pemberitahuan. MMC kemudian menampilkan file kumpulan Bantuan dengan topik MMC default yang dipilih.

Persyaratan

Lihat juga

ISnapinHelp2::GetHelpTopic

MMCPropertyHelp