Metode IAccessible::get_accKeyboardShortcut (oleacc.h)

Metode IAccessible::get_accKeyboardShortcut mengambil kunci pintasan atau kunci akses objek yang ditentukan, juga dikenal sebagai mnemonic. Semua objek yang memiliki kunci pintasan atau kunci akses mendukung properti ini.

Sintaks

HRESULT get_accKeyboardShortcut(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszKeyboardShortcut
);

Parameter

[in] varChild

Jenis: VARIAN

Menentukan apakah pintasan keyboard 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 VARIAN, lihat Bagaimana ID Anak Digunakan dalam Parameter.

[out, retval] pszKeyboardShortcut

Jenis: BSTR*

Alamat BSTR yang menerima string yang dilokalkan yang mengidentifikasi pintasan keyboard, atau NULL jika tidak ada pintasan keyboard yang terkait dengan objek yang ditentukan.

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	Objek tidak memiliki pintasan keyboard terkait.
E_INVALIDARG	Argumen tidak valid.
DISP_E_MEMBERNOTFOUND	Objek tidak mendukung properti ini.

Keterangan

Kunci akses adalah karakter bergaris bawah dalam teks menu, item menu, atau label tombol atau kontrol lainnya. Misalnya, pengguna dapat menampilkan menu dengan menekan tombol ALT sambil juga menekan tombol bergaris bawah yang ditunjukkan, seperti ALT+F untuk membuka menu ile F. Untuk menggunakan kunci akses item menu, menu yang berisi item harus aktif.

Kontrol seperti tombol toolbar dan item menu sering memiliki tombol pintasan terkait, juga dikenal sebagai akselerator keyboard. Beberapa item menu mungkin memiliki kunci akses dan kunci pintasan, dan beberapa mungkin hanya memiliki satu. Misalnya, item menu bernama New memiliki kunci akses N dan kunci pintasan CTRL+N. Menu tidak harus aktif agar kunci pintasan berfungsi.

Catatan untuk pengembang klien:

Jika properti ini mengembalikan satu karakter, Anda tidak dapat menganggapnya sebagai kunci akses atau pintasan keyboard. Dengan item menu standar, kunci akses dikembalikan oleh IAccessible::get_accKeyboardShortcut, dan kunci pintasan dikembalikan sebagai bagian dari nama item menu yang dikembalikan dari IAccessible::get_accName. Secara umum, tombol akses cenderung didefinisikan sebagai ALT + <huruf>, dan pintasan keyboard cenderung CTRL + <huruf>.

Catatan untuk pengembang server: Jika elemen UI dapat menerima fokus keyboard, maka Anda harus mengekspos kunci akses untuk elemen tersebut. Jika elemen UI tidak dapat menerima fokus keyboard (seperti ikon toolbar), maka Anda harus menampilkan tombol pintasan.

Karena kunci pintasan biasanya ditentukan oleh aplikasi daripada oleh kontrol itu sendiri, server biasanya dapat mengembalikan nilai yang diperoleh dari objek standar yang dapat diakses untuk jendela.

Contoh Klien

Contoh fungsi berikut mengambil pintasan keyboard untuk objek yang dapat diakses yang ditentukan, atau salah satu turunannya, dan mencetaknya ke konsol.

HRESULT PrintShortcut(IAccessible* pAcc, long child)
{
    if (pAcc == NULL)
    {
        return E_INVALIDARG;
    }
    BSTR bstrShortcut;
    VARIANT varObj;
    varObj.vt = VT_I4;
    varObj.lVal = child;
    HRESULT hr = pAcc->get_accKeyboardShortcut(varObj, &bstrShortcut);
    if (hr == S_OK)
    {
        printf("Shortcut: %S\n", bstrShortcut);
        SysFreeString(bstrShortcut);
    }
    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

IAccessible

IAccessible::get_accName

Properti KeyboardShortcut

VARIAN