Fungsi MMCPropertyHelp (mmc.h)

Fungsi MMCPropertyHelp diperkenalkan dalam MMC 1.1.

Fungsi MMCPropertyHelp menampilkan topik Bantuan HTML yang ditentukan dalam file Bantuan HTML MMC gabungan untuk halaman properti.

Sintaks

HRESULT MMCPropertyHelp(
  LPOLESTR pszHelpTopic
);

Parameter

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 file Bantuan HTML snap-in (.chm) yang digabungkan MMC ke dalam file Bantuan HTML MMC (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.

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

mysnapin.chm::htm/snphlp01.htm

Dukungan untuk ID numerik untuk topik tidak tersedia dalam rilis ini.

Menampilkan nilai

Fungsi panggilan balik ini dapat mengembalikan salah satu nilai ini.

Keterangan

Panggil MMCPropertyHelp di penangan pemberitahuan untuk pemberitahuan MMCN_CONTEXTHELP .

Snap-in dapat memberikan bantuan konteks di halaman properti. 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 marshaling 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 memunculkan daftar isi dengan topik MMC default yang dipilih.

Persyaratan

Lihat juga

IDisplayHelp::ShowTopic

ISnapinHelp2::GetHelpTopic