Fungsi HtmlHelpA (htmlhelp.h)

Artikel
11/20/2024

Menampilkan jendela bantuan.

Dengan menggunakan perintah API, Anda dapat menentukan topik mana yang akan ditampilkan di jendela bantuan, apakah jendela bantuan adalah Penampil Bantuan tiga panel atau jendela pop-up, dan apakah file topik HTML harus diakses melalui ID konteks, URL Bantuan HTML , atau pencarian Tautan kata kunci (KLink).

Sintaksis

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

Parameter

[in, optional] hwndCaller

Menentukan handel (hwnd) dari jendela yang memanggil HtmlHelp. Jendela bantuan dimiliki oleh jendela ini.

Ketika jendela bantuan ditutup, HtmlHelp akan mengembalikan fokus kepada pemilik kecuali pemiliknya adalah desktop. Jika hwndCaller adalah desktop, maka sistem operasi menentukan di mana fokus dikembalikan.

Selain itu, jika HtmlHelp mengirim pesan pemberitahuan apa pun dari jendela bantuan, pesan tersebut dikirim ke hwndCaller selama Anda telah mengaktifkan pesan pemberitahuan pelacakan dalam definisi jendela bantuan.

[in] pszFile

Bergantung pada nilai uCommand , menentukan jalur file ke file bantuan yang dikompilasi (.chm), atau file topik dalam file bantuan tertentu.

Nama jenis jendela juga dapat ditentukan, didahului dengan karakter yang lebih besar dari ().

Jika perintah yang ditentukan tidak memerlukan file, nilai ini mungkin NULL.

[in] uCommand

Menentukan perintah untuk diselesaikan.

[in] dwData

Menentukan data apa pun yang mungkin diperlukan, berdasarkan nilai parameter uCommand .

Mengembalikan nilai

Bergantung pada uCommand yang ditentukan dan hasilnya, HtmlHelp mengembalikan satu atau kedua hal berikut:

Handel (hwnd) dari jendela bantuan.
NULL. Dalam beberapa kasus, NULL menunjukkan kegagalan; dalam kasus lain, NULL menunjukkan bahwa jendela bantuan belum dibuat.

Komentar

Sintaksis berlaku untuk set karakter ANSI. Saat menggunakan set karakter Unicode, jenis parameter pszFile harus "LPCTSTR ".

Saat menggunakan HTML Help API, atur ukuran tumpukan hosting yang dapat dieksekusi ke setidaknya 100k. Jika ukuran tumpukan yang ditentukan terlalu kecil, maka utas yang dibuat untuk menjalankan Bantuan HTML juga akan dibuat dengan ukuran tumpukan ini, dan kegagalan dapat mengakibatkan. Secara opsional, Anda dapat menghapus /STACK dari baris perintah tautan, dan menghapus pengaturan STACK apa pun dalam file DEF yang dapat dieksekusi (ukuran tumpukan default adalah 1MB dalam hal ini). Anda juga dapat mengatur ukuran tumpukan menggunakan perintah /Fnumber compiler (pengkompilasi akan meneruskan ini ke linker sebagai /STACK).

Contoh

Contoh berikut memanggil perintah HH_DISPLAY_TOPIC untuk membuka file bantuan bernama Help.chm dan menampilkan topik defaultnya di jendela bantuan bernama Mainwin. Umumnya, jendela bantuan yang ditentukan dalam perintah ini adalah penampil bantuan HTML standar.

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

Nota

Header htmlhelp.h mendefinisikan HtmlHelp sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
Platform Target	Windows
Header	htmlhelp.h
Pustaka	Htmlhelp.lib
DLL	hhctrl.ocx

Lihat juga

Tentang API Bantuan HTML

Bagikan melalui