Freigeben über


IAccessible::get_accKeyboardShortcut-Methode (oleacc.h)

Die IAccessible::get_accKeyboardShortcut-Methode ruft die Tastenkombination oder zugriffstaste des angegebenen Objekts ab, die auch als mnemonisch bezeichnet wird. Alle Objekte, die über eine Tastenkombination oder einen Zugriffsschlüssel verfügen, unterstützen diese Eigenschaft.

Syntax

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

Parameter

[in] varChild

Typ: VARIANT

Gibt an, ob die abgerufene Tastenkombination zum Objekt oder zu einem der untergeordneten Elemente des Objekts gehört. Dieser Parameter ist entweder CHILDID_SELF (zum Abrufen von Informationen über das Objekt) oder eine untergeordnete ID (zum Abrufen von Informationen über das untergeordnete Element des Objekts). Weitere Informationen zum Initialisieren von VARIANT finden Sie unter Verwenden untergeordneter IDs in Parametern.

[out, retval] pszKeyboardShortcut

Typ: BSTR*

Adresse eines BSTR , der eine lokalisierte Zeichenfolge empfängt, die die Tastenkombination identifiziert, oder NULL , wenn dem angegebenen Objekt keine Tastenkombination zugeordnet ist.

Rückgabewert

Typ: HRESULT

Gibt bei Erfolg S_OK zurück.

Wenn dies nicht erfolgreich ist, gibt einen der Werte in der folgenden Tabelle oder einen anderen COM-Standardfehlercode zurück. Server geben diese Werte zurück, aber Clients müssen die Ausgabeparameter immer überprüfen, um sicherzustellen, dass sie gültige Werte enthalten. Weitere Informationen finden Sie unter Überprüfen von IAccessible-Rückgabewerten.

Fehler BESCHREIBUNG
S_FALSE
Das -Objekt verfügt nicht über eine zugeordnete Tastenkombination.
E_INVALIDARG
Ein Argument ist ungültig.
DISP_E_MEMBERNOTFOUND
Das -Objekt unterstützt diese Eigenschaft nicht.

Hinweise

Eine Zugriffstaste ist ein unterstrichenes Zeichen im Text eines Menüs, Menüelements oder einer Bezeichnung einer Schaltfläche oder eines anderen Steuerelements. Beispielsweise kann ein Benutzer ein Menü anzeigen, indem er die ALT-TASTE drückt und gleichzeitig die angegebene unterstrichene Taste wie ALT+F drückt, um das Menü File zu öffnen. Um die Zugriffsschlüssel eines Menüelements verwenden zu können, muss das Menü, das das Element enthält, aktiv sein.

Steuerelemente wie Symbolleistenschaltflächen und Menüelemente verfügen häufig über eine zugeordnete Tastenkombination, die auch als Tastenkombination bezeichnet wird. Einige Menüelemente verfügen möglicherweise sowohl über eine Zugriffstaste als auch über eine Tastenkombination, und einige haben möglicherweise nur eine. Ein Menüelement mit dem Namen New verfügt beispielsweise über eine Zugriffstaste N und eine Tastenkombination STRG+N. Das Menü muss nicht aktiv sein, damit die Tastenkombination funktioniert.

Hinweis für Cliententwickler:

Wenn diese Eigenschaft ein einzelnes Zeichen zurückgibt, können Sie nicht davon ausgehen, dass es sich um eine Zugriffstaste oder eine Tastenkombination handelt. Bei Standardmenüelementen wird die Zugriffsschlüssel von IAccessible::get_accKeyboardShortcut zurückgegeben, und die Tastenkombination wird als Teil des Von IAccessible::get_accName zurückgegebenen Menüelementnamens zurückgegeben. Im Allgemeinen werden Zugriffstasten in der Regel als ALT + <Buchstabe> definiert, und Tastenkombinationen sind in der Regel STRG + <Buchstabe>.

Hinweis für Serverentwickler: Wenn das Ui-Element den Tastaturfokus erhalten kann, sollten Sie die Zugriffstaste für das Element verfügbar machen. Wenn das Ui-Element den Tastaturfokus (z. B. Symbolleistensymbole) nicht erhalten kann, sollten Sie die Tastenkombination anzeigen.

Da Tastenkombinationen in der Regel von der Anwendung und nicht vom Steuerelement selbst bestimmt werden, können Server in der Regel den Wert zurückgeben, der aus dem standard zugänglichen Objekt für das Fenster abgerufen wurde.

Clientbeispiel

Die folgende Beispielfunktion ruft die Tastenkombination für das angegebene barrierefreie Objekt oder eines seiner untergeordneten Elemente ab und gibt sie in der Konsole aus.

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;
}

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile oleacc.h
Bibliothek Oleacc.lib
DLL Oleacc.dll
Verteilbare Komponente Active Accessibility 1.3 RDK unter Windows NT 4.0 mit SP6 und höher und Windows 95

Weitere Informationen

Iaccessible

IAccessible::get_accName

KeyboardShortcut-Eigenschaft

VARIANTE