Metodo IAccessible::get_accHelp (oleacc.h)

Articolo
02/29/2024

Il metodo IAccessible::get_accHelp recupera la stringa della proprietà Help di un oggetto . Non tutti gli oggetti supportano questa proprietà.

Sintassi

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

Parametri

[in] varChild

Tipo: VARIANT

Specifica se le informazioni della Guida recuperate appartengono 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 su uno degli elementi figlio dell'oggetto). Per altre informazioni sull'inizializzazione di VARIANT, vedere Modalità di utilizzo degli ID figlio nei parametri.

[out, retval] pszHelp

Tipo: BSTR*

Indirizzo di un oggetto BSTR che riceve la stringa localizzata contenente le informazioni della Guida per l'oggetto specificato oppure NULL se non sono disponibili informazioni della Guida.

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	Nessuna informazione della Guida disponibile.
E_INVALIDARG	Un argomento non è valido.
DISP_E_MEMBERNOTFOUND	L'oggetto non supporta questa proprietà.

Commenti

Nessuno dei controlli predefiniti e comuni supporta questa proprietà.

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

Questa proprietà restituisce una stringa, mentre IAccessible::get_accHelpTopic fornisce l'accesso a un argomento della Guida in WinHelp. Gli oggetti non sono necessari per supportare sia IAccessible::get_accHelp che IAccessible::get_accHelpTopic, ma devono supportare almeno uno. Se restituiscono facilmente una stringa, devono supportare IAccessible::get_accHelp ; altrimenti devono supportare IAccessible::get_accHelpTopic. Se entrambi sono supportati, IAccessible::get_accHelpTopic fornisce informazioni più dettagliate.

Esempio di server

Il codice di esempio seguente mostra una possibile implementazione di questo metodo per una casella di riepilogo personalizzata. Viene visualizzato testo diverso a seconda dello stato del contatto nell'elenco. Per semplicità, l'esempio non localizza la stringa restituita.


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    return S_OK;
};

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