Metode IAccessible::get_accHelp (oleacc.h)

Artikel
03/05/2024

Metode IAccessible::get_accHelp mengambil string properti Bantuan dari objek. Tidak semua objek mendukung properti ini.

Sintaks

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

Parameter

[in] varChild

Jenis: VARIAN

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

[out, retval] pszHelp

Jenis: BSTR*

Alamat BSTR yang menerima string yang dilokalkan yang berisi informasi bantuan untuk objek yang ditentukan, atau NULL jika tidak ada informasi bantuan yang tersedia.

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

Tidak ada kontrol yang telah ditentukan sebelumnya dan umum yang mendukung properti ini.

Catatan untuk pengembang server: Lokalkan string yang dikembalikan dari properti ini.

Properti ini mengembalikan string, sedangkan IAccessible::get_accHelpTopic menyediakan akses ke topik Bantuan di WinHelp. Objek tidak diperlukan untuk mendukung IAccessible::get_accHelp dan IAccessible::get_accHelpTopic, tetapi harus mendukung setidaknya satu. Jika mereka 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.

Contoh Server

Contoh kode berikut menunjukkan satu kemungkinan implementasi metode ini untuk kotak daftar kustom. Teks yang berbeda ditampilkan tergantung pada status kontak dalam daftar. Untuk kesederhanaan, contoh tidak melokalisasi string yang dikembalikan.


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    return S_OK;
};

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