IAgentCharacterEx::SetHelpContextID

[Microsoft Agent tidak digunakan lagi pada Windows 7, dan mungkin tidak tersedia dalam versi Windows berikutnya.]

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Mengatur HelpContextID untuk karakter.

  • Mengembalikan S_OK untuk menunjukkan operasi berhasil.

ulHelpID

Jumlah konteks topik bantuan untuk dikaitkan dengan karakter; digunakan untuk memberikan Bantuan peka konteks untuk karakter.

Jika Anda telah membuat file Bantuan Windows untuk aplikasi Anda dan mengaturnya di properti HelpFile karakter, Agen Microsoft secara otomatis memanggil Bantuan saat HelpModeOn diatur ke True dan pengguna memilih karakter. Jika ada nomor konteks di HelpContextID, Agen memanggil Bantuan dan mencari topik yang diidentifikasi oleh nomor konteks saat ini. Nomor konteks saat ini adalah nilai HelpContextID untuk karakter. Jika ada nomor konteks di properti HelpContextID , Bantuan menampilkan topik yang sesuai dengan konteks Bantuan saat ini; jika tidak, ia menampilkan "Tidak ada topik Bantuan yang terkait dengan item ini."

Pengaturan ini hanya berlaku ketika aplikasi klien Anda adalah klien aktif dari karakter paling atas. Ini tidak mempengaruhi klien lain dari karakter atau karakter lain yang digunakan aplikasi klien Anda.

Catatan

Membuat file Bantuan memerlukan Pengkompilasi Bantuan Microsoft Windows.

 

Lihat juga

IAgentCharacterEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName