Metode IAccessible::get_accHelpTopic (oleacc.h)

  • Artikel

Metode IAccessible::get_accHelpTopic mengambil jalur lengkap file WinHelp yang terkait dengan objek yang ditentukan; ini juga mengambil pengidentifikasi topik yang sesuai dalam file tersebut. Tidak semua objek mendukung properti ini. Properti ini jarang didukung atau digunakan oleh aplikasi

CatatanIAccessible::get_accHelpTopic tidak digunakan lagi dan tidak boleh digunakan.
 

Sintaks

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

Parameter

[out] pszHelpFile

Jenis: BSTR*

Alamat BSTR yang menerima jalur lengkap file WinHelp yang terkait dengan objek yang ditentukan.

[in] varChild

Jenis: VARIAN

Menentukan apakah topik Bantuan yang diambil milik objek atau salah satu elemen anak objek. Parameter ini CHILDID_SELF (untuk mendapatkan topik Bantuan untuk objek) atau ID anak (untuk mendapatkan topik Bantuan untuk salah satu elemen anak objek). Untuk informasi selengkapnya tentang menginisialisasi VARIAN, lihat Bagaimana ID Anak Digunakan dalam Parameter.

pidTopic

Jenis: panjang*

[out, retval] Alamat variabel yang mengidentifikasi topik file Bantuan yang terkait dengan objek yang ditentukan. Nilai ini digunakan sebagai pengidentifikasi konteks dari topik yang diinginkan yang diteruskan ke fungsi WinHelp . Saat memanggil WinHelp untuk menampilkan topik, atur parameter uCommand ke HELP_CONTEXT, transmisikan nilai yang diarahkan oleh pidTopic ke DWORD, dan teruskan sebagai parameter dwData .

Nilai kembali

Jenis: HRESULT

Jika berhasil, mengembalikan S_OK.

Jika tidak berhasil, mengembalikan salah satu nilai dalam tabel berikut, atau kode kesalahan COM standar lainnya. Server mengembalikan nilai-nilai ini, tetapi klien harus selalu memeriksa parameter output untuk memastikan bahwa nilai tersebut berisi nilai yang valid. Untuk informasi selengkapnya, lihat Memeriksa Nilai Pengembalian IAccessible.

Kesalahan Deskripsi
S_FALSE
 Tidak ada informasi Bantuan yang tersedia.
E_INVALIDARG
 Argumen tidak valid.
DISP_E_MEMBERNOTFOUND
 Objek tidak mendukung properti ini.

Keterangan

Mendapatkan informasi dari file Bantuan mungkin bersifat waktu dan memori intensif.

Catatan untuk pengembang server: Properti ini menyediakan akses ke topik Bantuan di WinHelp, sedangkan IAccessible::get_accHelp mengembalikan string. Objek tidak diperlukan untuk mendukung IAccessible::get_accHelp dan IAccessible::get_accHelpTopic, tetapi harus mendukung setidaknya satu. Jika mereka dapat dengan mudah mengembalikan string, mereka harus mendukung IAccessible::get_accHelp; jika tidak, mereka harus mendukung IAccessible::get_accHelpTopic. Jika keduanya didukung, IAccessible::get_accHelpTopic memberikan informasi yang lebih rinci.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2003 [hanya aplikasi desktop]
Target Platform Windows
Header oleacc.h
Pustaka Oleacc.lib
DLL Oleacc.dll
Redistribusi Aksesibilitas Aktif 1.3 RDK di Windows NT 4.0 dengan SP6 dan yang lebih baru dan Windows 95

Lihat juga

Properti HelpTopic

IAccessible

IAccessible::get_accHelp