Metodo IAccessible::get_accKeyboardShortcut (oleacc.h)

Articolo
08/25/2023

Il metodo IAccessible::get_accKeyboardShortcut recupera il tasto di scelta rapida o il tasto di scelta rapida dell'oggetto specificato, noto anche come mnemonic. Tutti gli oggetti con un tasto di scelta rapida o un tasto di scelta rapida supportano questa proprietà.

Sintassi

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

Parametri

[in] varChild

Tipo: VARIANT

Specifica se il tasto di scelta rapida recuperato appartiene all'oggetto o a uno degli elementi figlio dell'oggetto. Questo parametro è CHILDID_SELF (per ottenere informazioni sull'oggetto) o un ID figlio (per ottenere informazioni sull'elemento figlio dell'oggetto). Per altre informazioni sull'inizializzazione di VARIANT, vedere Modalità di utilizzo degli ID figlio nei parametri.

[out, retval] pszKeyboardShortcut

Tipo: BSTR*

Indirizzo di una stringa BSTR che riceve una stringa localizzata che identifica la scelta rapida da tastiera o NULL se all'oggetto specificato non è associato alcun tasto di scelta rapida.

Valore restituito

Tipo: HRESULT

Se ha esito positivo, restituisce S_OK.

In caso contrario, restituisce uno dei valori della tabella che segue o un altro codice di errore COM standard. I server restituiscono questi valori, ma i client devono sempre controllare i parametri di output per assicurarsi che contengano valori validi. Per altre informazioni, vedere Controllo dei valori restituiti IAccessible.

Errore	Descrizione
S_FALSE	L'oggetto non dispone di un tasto di scelta rapida associato.
E_INVALIDARG	Un argomento non è valido.
DISP_E_MEMBERNOTFOUND	L'oggetto non supporta questa proprietà.

Commenti

Un tasto di scelta è un carattere sottolineato nel testo di un menu, di una voce di menu o di un'etichetta di un pulsante o di un altro controllo. Ad esempio, un utente può visualizzare un menu premendo ALT premendo anche il tasto sottolineato indicato, ad esempio ALT+F per aprire il menu File. Per utilizzare il tasto di scelta di una voce di menu, il menu che contiene l'elemento deve essere attivo.

I controlli, ad esempio i pulsanti della barra degli strumenti e le voci di menu, spesso hanno un tasto di scelta rapida associato, noto anche come tasto di scelta rapida. Alcune voci di menu possono avere sia un tasto di scelta che un tasto di scelta rapida e alcuni possono avere solo uno. Ad esempio, una voce di menu denominata New ha un tasto di scelta rapida N e un tasto di scelta rapida CTRL+N. Non è necessario che il menu sia attivo per il funzionamento del tasto di scelta rapida.

Nota per gli sviluppatori client:

Se questa proprietà restituisce un singolo carattere, non è possibile presupporre che sia un tasto di scelta rapida o un tasto di scelta rapida. Con le voci di menu standard, il tasto di scelta viene restituito da IAccessible::get_accKeyboardShortcut e il tasto di scelta rapida viene restituito come parte del nome della voce di menu restituito da IAccessible::get_accName. In generale, i tasti di scelta tendono a essere definiti come ALT + <lettera> e i tasti di scelta rapida tendono a essere CTRL + <lettera>.

Nota per gli sviluppatori di server: Se l'elemento dell'interfaccia utente può ricevere lo stato attivo della tastiera, è necessario esporre il tasto di scelta per l'elemento . Se l'elemento dell'interfaccia utente non può ricevere lo stato attivo della tastiera (ad esempio le icone della barra degli strumenti), è necessario visualizzare il tasto di scelta rapida.

Poiché i tasti di scelta rapida sono in genere determinati dall'applicazione anziché dal controllo stesso, i server possono in genere restituire il valore ottenuto dall'oggetto accessibile standard per la finestra.

Esempio di client

La funzione di esempio seguente recupera il tasto di scelta rapida per l'oggetto accessibile specificato o uno dei relativi elementi figlio e lo stampa nella console.


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

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	oleacc.h
Libreria	Oleacc.lib
DLL	Oleacc.dll
Componente ridistribuibile	Accessibilità attiva 1.3 RDK in Windows NT 4.0 con SP6 e versioni successive e Windows 95