Fungsi WinHelpW (winuser.h)

Artikel
11/20/2024

Meluncurkan Bantuan Windows (Winhelp.exe) dan meneruskan data tambahan yang menunjukkan sifat bantuan yang diminta oleh aplikasi.

Sintaksis

BOOL WinHelpW(
  HWND      hWndMain,
  LPCWSTR   lpszHelp,
  UINT      uCommand,
  ULONG_PTR dwData
);

Parameter

hWndMain

Jenis: HWND

Handel ke jendela yang meminta bantuan. Fungsi WinHelp menggunakan handel ini untuk melacak aplikasi mana yang telah meminta bantuan. Jika parameter uCommand menentukan HELP_CONTEXTMENU atau HELP_WM_HELP, hWndMain mengidentifikasi kontrol yang meminta bantuan.

lpszHelp

Jenis: LPCTSTR

Alamat string yang dihentikan null yang berisi jalur, jika perlu, dan nama file Bantuan yang WinHelp adalah untuk ditampilkan.

Nama file dapat diikuti oleh tanda kurung sudut (>) dan nama jendela sekunder jika topik akan ditampilkan di jendela sekunder daripada di jendela utama. Anda harus menentukan nama jendela sekunder di bagian [WINDOWS] dari file Proyek bantuan (.hpj).

uCommand

Jenis: UINT

Jenis bantuan yang diminta. Untuk daftar nilai yang mungkin dan bagaimana nilai memengaruhi nilai yang akan ditempatkan di parameter dwData, lihat bagian Keterangan.

dwData

Jenis: ULONG_PTR

Data tambahan. Nilai yang digunakan tergantung pada nilai parameter uCommand . Untuk daftar kemungkinan nilai dwData, lihat bagian Keterangan.

Mengembalikan nilai

Jenis: BOOL

Mengembalikan bukan nol jika berhasil, atau nol sebaliknya. Untuk mengambil informasi kesalahan yang diperluas, panggil GetLastError.

Komentar

Sebelum menutup jendela yang meminta bantuan, aplikasi harus memanggil WinHelp dengan parameter uCommand diatur ke HELP_QUIT. Hingga semua aplikasi melakukan ini, Bantuan Windows tidak akan dihentikan. Perhatikan bahwa memanggil Bantuan Windows dengan perintah HELP_QUIT tidak diperlukan jika Anda menggunakan perintah HELP_CONTEXTPOPUP untuk memulai Bantuan Windows.

Fungsi ini gagal jika dipanggil dari konteks apa pun tetapi pengguna saat ini.

Tabel berikut ini memperlihatkan nilai yang mungkin untuk parameter uCommand dan format yang sesuai dari parameter dwData .

uCommand	Perbuatan	dwData
HELP_COMMAND	Menjalankan string makro atau makro Bantuan.	Alamat string yang menentukan nama makro Bantuan yang akan dijalankan. Jika string menentukan beberapa nama makro, nama harus dipisahkan oleh titik koma. Anda harus menggunakan bentuk pendek nama makro untuk beberapa makro karena Bantuan Windows tidak mendukung nama panjang.
HELP_CONTENTS	Menampilkan topik yang ditentukan oleh opsi Konten di bagian [OPTIONS] dari file .hpj. Perintah ini untuk kompatibilitas mundur. Aplikasi baru harus menyediakan file .cnt dan menggunakan perintah HELP_FINDER.	Diabaikan; atur ke 0.
HELP_CONTEXT	Menampilkan topik yang diidentifikasi oleh pengidentifikasi konteks yang ditentukan di bagian [MAP] dari file .hpj.	Berisi pengidentifikasi konteks untuk topik tersebut.
HELP_CONTEXTMENU	Menampilkan menu Bantuan untuk jendela terpilih, lalu menampilkan topik untuk kontrol terpilih di jendela pop-up.	Alamat array pasangan DWORD . DWORD pertama di setiap pasangan adalah pengidentifikasi kontrol, dan yang kedua adalah pengidentifikasi konteks untuk topik tersebut. Array harus dihentikan oleh sepasang nol {0,0}. Jika Anda tidak ingin menambahkan Bantuan ke kontrol tertentu, atur pengidentifikasi konteksnya ke -1.
HELP_CONTEXTPOPUP	Menampilkan topik yang diidentifikasi oleh pengidentifikasi konteks yang ditentukan di bagian [MAP] dari file .hpj di jendela pop-up.	Berisi pengidentifikasi konteks untuk topik.
HELP_FINDER	Menampilkan kotak dialog Topik Bantuan.	Diabaikan; atur ke 0.
HELP_FORCEFILE	Memastikan bahwa Bantuan Windows menampilkan file Bantuan yang benar. Jika file Bantuan yang salah ditampilkan, Bantuan Windows akan membuka file yang benar; jika tidak, tidak ada tindakan.	Diabaikan; atur ke 0.
HELP_HELPONHELP	Menampilkan bantuan tentang cara menggunakan Bantuan Windows, jika file Winhlp32.hlp tersedia.	Diabaikan; atur ke 0.
HELP_INDEX	Menampilkan topik yang ditentukan oleh opsi Konten di bagian [OPTIONS] dari file .hpj. Perintah ini untuk kompatibilitas mundur. Aplikasi baru harus menggunakan perintah HELP_FINDER.	Diabaikan; atur ke 0.
HELP_KEY	Menampilkan topik dalam tabel kata kunci yang cocok dengan kata kunci yang ditentukan, jika ada kecocokan yang tepat. Jika ada lebih dari satu kecocokan, menampilkan Indeks dengan topik yang tercantum dalam kotak daftar Topik Ditemukan.	Alamat string kata kunci. Beberapa kata kunci harus dipisahkan oleh titik koma.
HELP_MULTIKEY	Menampilkan topik yang ditentukan oleh kata kunci dalam tabel kata kunci alternatif.	Alamat struktur MULTIKEYHELP yang menentukan karakter catatan kaki tabel dan kata kunci.
HELP_PARTIALKEY	Menampilkan topik dalam tabel kata kunci yang cocok dengan kata kunci yang ditentukan, jika ada kecocokan yang tepat. Jika ada lebih dari satu kecocokan, menampilkan kotak dialog Topik Ditemukan. Untuk menampilkan indeks tanpa meneruskan kata kunci, gunakan penunjuk ke string kosong.	Alamat string kata kunci. Beberapa kata kunci harus dipisahkan oleh titik koma.
HELP_QUIT	Menginformasikan Bantuan Windows bahwa ia tidak lagi diperlukan. Jika tidak ada aplikasi lain yang meminta bantuan, Windows akan menutup Bantuan Windows.	Diabaikan; atur ke 0.
HELP_SETCONTENTS	Menentukan topik Isi. Bantuan Windows menampilkan topik ini ketika pengguna mengklik tombol Isi jika file Bantuan tidak memiliki file .cnt terkait.	Berisi pengidentifikasi konteks untuk topik Konten.
HELP_SETPOPUP_POS	Mengatur posisi jendela pop-up berikutnya.	Berisi data posisi. Gunakan MAKELONG untuk menggabungkan koordinat horizontal dan vertikal ke dalam satu nilai. Jendela pop-up diposisikan seolah-olah kursor mouse berada pada titik yang ditentukan ketika jendela pop-up dipanggil.
HELP_SETWINPOS	Menampilkan jendela Bantuan Windows, jika diminimalkan atau dalam memori, dan menyetel ukuran dan posisinya seperti yang ditentukan.	Alamat struktur HELPWININFO yang menentukan ukuran dan posisi jendela Bantuan primer atau sekunder.
HELP_TCARD	Menunjukkan bahwa perintah adalah untuk instans kartu pelatihan Bantuan Windows. Gabungkan perintah ini dengan perintah lain menggunakan operator BITWISE OR.	Tergantung pada perintah yang perintah ini digabungkan.
HELP_WM_HELP	Menampilkan topik untuk kontrol yang diidentifikasi oleh parameter hWndMain di jendela pop-up.	Alamat array pasangan DWORD . DWORD pertama di setiap pasangan adalah pengidentifikasi kontrol, dan yang kedua adalah pengidentifikasi konteks untuk topik. Array harus dihentikan oleh sepasang nol {0,0}. Jika Anda tidak ingin menambahkan Bantuan ke kontrol tertentu, atur pengidentifikasi konteksnya ke -1.

Nota

Header winuser.h mendefinisikan WinHelp 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
klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	winuser.h
Pustaka	User32.lib
DLL	User32.dll
set API	ext-ms-win-ntuser-misc-l1-5-1 (diperkenalkan di Windows 10, versi 10.0.14393)

Lihat juga

HELPWININFO

MULTIKEYHELP

Bagikan melalui