Metode IAccessible::get_accDescription (oleacc.h)
Metode IAccessible::get_accDescription mengambil string yang menjelaskan tampilan visual objek yang ditentukan. Tidak semua objek memiliki deskripsi.
Sintaks
HRESULT get_accDescription(
[in] VARIANT varChild,
[out, retval] BSTR *pszDescription
);
Parameter
[in] varChild
Jenis: VARIAN
Menentukan apakah deskripsi 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 elemen anak objek). Untuk informasi selengkapnya tentang menginisialisasi struktur VARIAN, lihat Bagaimana ID Anak Digunakan dalam Parameter.
[out, retval] pszDescription
Jenis: BSTR*
Alamat BSTR yang menerima string yang dilokalkan yang menjelaskan objek yang ditentukan, atau NULL jika objek ini tidak memiliki deskripsi.
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.
Menampilkan kode | Deskripsi |
---|---|
|
Objek yang ditentukan tidak memiliki deskripsi. |
|
Argumen tidak valid. |
|
Objek yang ditentukan tidak mendukung properti ini. |
Keterangan
Server Aksesibilitas Aktif Microsoft dapat menambahkan dukungan untuk Otomatisasi UI dengan menggunakan Anotasi Langsung, menggunakan antarmuka IAccessibleEx , atau dengan menerapkan Aksesibilitas Aktif Microsoft dan Otomatisasi UI berdampingan dengan kedua implementasi yang menangani pesan WM_GETOBJECT .
Properti ini menyediakan tekstual yang setara dengan objek untuk pengguna. Deskripsi harus mirip dengan teks yang disediakan dengan atribut ALT dalam HTML, yang merupakan teks yang ditampilkan untuk menggambarkan gambar bagi orang yang menggunakan browser teks-saja. Namun, beberapa kontrol menggunakan properti ini untuk menyimpan informasi tambahan tentang kontrol yang tidak terkait dengan setara tekstual. Untuk informasi selengkapnya tentang properti ini, lihat Properti Deskripsi.
Catatan untuk pengembang server: Lokalkan string yang dikembalikan dari properti ini.
Contoh Server
Contoh kode berikut menunjukkan satu kemungkinan implementasi metode ini untuk kotak daftar kustom yang mempertahankan elemen anaknya sendiri. Contoh menunjukkan sintaks, tetapi ingat bahwa kotak daftar teks-saja nyata mungkin tidak perlu mendukung properti ini. Untuk kesederhanaan, string dalam contoh tidak dilokalkan.
HRESULT STDMETHODCALLTYPE AccServer::get_accDescription(
VARIANT varChild,
BSTR *pszDescription)
{
if (varChild.vt != VT_I4)
{
*pszDescription = NULL;
return E_INVALIDARG;
}
if (varChild.lVal == CHILDID_SELF)
{
*pszDescription = SysAllocString(L"List of contacts.");
}
else
{
*pszDescription = SysAllocString(L"A contact.");
}
return S_OK;
};
Contoh Klien
Contoh fungsi berikut mengambil deskripsi objek yang dapat diakses yang ditentukan, atau elemen anak, dan menampilkannya di konsol.
HRESULT PrintDescription(IAccessible* pAcc, long child)
{
VARIANT varObject;
varObject.vt = VT_I4;
varObject.lVal = child;
BSTR bstrDesc;
HRESULT hr = pAcc->get_accDescription(varObject, &bstrDesc);
if (hr == S_OK)
{
printf("Description: %S\n", bstrDesc);
SysFreeString(bstrDesc);
}
return hr;
}
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
Konseptual
Referensi