Metodo IAccess::get_accDescription (oleacc.h)

Articolo
02/29/2024

Il metodo IAccess::get_accDescription recupera una stringa che descrive l'aspetto visivo dell'oggetto specificato. Non a tutti gli oggetti è associata una descrizione.

Nota La proprietà Description viene spesso usata in modo errato e non è supportata da Microsoft Automazione interfaccia utente. Gli sviluppatori del server di accessibilità microsoft active non devono usare questa proprietà. Se sono necessarie altre informazioni per scenari di accessibilità e automazione, usare le proprietà supportate da Automazione interfaccia utente elementi e modelli di controllo.

Sintassi

HRESULT get_accDescription(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszDescription
);

Parametri

[in] varChild

Tipo: VARIANT

Specifica se la descrizione recuperata 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 della struttura VARIANT, vedere Come vengono usati gli ID figlio nei parametri.

[out, retval] pszDescription

Tipo: BSTR*

Indirizzo di una stringa BSTR che riceve una stringa localizzata che descrive l'oggetto specificato o NULL se questo oggetto non ha una descrizione.

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 IAccessibile.

Codice restituito	Descrizione
S_FALSE	L'oggetto specificato non ha una descrizione.
E_INVALIDARG	Un argomento non è valido.
DISP_E_MEMBERNOTFOUND	L'oggetto specificato non supporta questa proprietà.

Commenti

Un server Microsoft Active Accessibility può aggiungere supporto per Automazione interfaccia utente usando l'annotazione diretta, usando l'interfaccia IAccessEx o implementando Microsoft Active Accessibility e Automazione interfaccia utente side-by-side con entrambe le implementazioni che gestiscono il messaggio di WM_GETOBJECT.

Questa proprietà fornisce un equivalente testuale dell'oggetto per l'utente. La descrizione deve essere simile al testo fornito con l'attributo ALT in HTML, ovvero il testo visualizzato per descrivere le immagini per le persone che usano browser solo di testo. Tuttavia, alcuni controlli usano questa proprietà per archiviare informazioni aggiuntive sul controllo che non è correlato a un equivalente testuale. Per altre informazioni su questa proprietà, vedere Proprietà description.

Nota per gli sviluppatori del server: Localizzare la stringa restituita da questa proprietà.

Esempio di server

Il codice di esempio seguente mostra una possibile implementazione di questo metodo per una casella di riepilogo personalizzata che gestisce i propri elementi figlio. L'esempio illustra la sintassi, ma ricorda che una casella di riepilogo di sola testo reale probabilmente non deve supportare questa proprietà. Per semplicità, le stringhe nell'esempio non sono localizzate.


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

Esempio client

La funzione di esempio seguente recupera la descrizione dell'oggetto accessibile specificato o un elemento figlio e la visualizza nella console.


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

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