IAccessible::get_accHelp-Methode (oleacc.h)

Artikel
03/04/2024

Die IAccessible::get_accHelp-Methode ruft die Help-Eigenschaftszeichenfolge eines Objekts ab. Diese Eigenschaft wird nicht von allen Objekten unterstützt.

Syntax

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

Parameter

[in] varChild

Typ: VARIANT

Gibt an, ob die abgerufenen Hilfeinformationen zum Objekt oder zu einem der untergeordneten Elemente des Objekts gehören. Dieser Parameter ist entweder CHILDID_SELF (zum Abrufen von Informationen zum Objekt) oder eine untergeordnete ID (um Informationen zu einem der untergeordneten Elemente des Objekts abzurufen). Weitere Informationen zum Initialisieren von VARIANT finden Sie unter Verwenden untergeordneter IDs in Parametern.

[out, retval] pszHelp

Typ: BSTR*

Adresse eines BSTR , der die lokalisierte Zeichenfolge mit den Hilfeinformationen für das angegebene Objekt empfängt, oder NULL , wenn keine Hilfeinformationen verfügbar sind.

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 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	Es sind keine Hilfeinformationen verfügbar.
E_INVALIDARG	Ein Argument ist ungültig.
DISP_E_MEMBERNOTFOUND	Diese Eigenschaft wird vom Objekt nicht unterstützt.

Hinweise

Keines der vordefinierten und gängigen Steuerelemente unterstützt diese Eigenschaft.

Hinweis für Serverentwickler: Lokalisieren Sie die von dieser Eigenschaft zurückgegebene Zeichenfolge.

Diese Eigenschaft gibt eine Zeichenfolge zurück, während IAccessible::get_accHelpTopic Zugriff auf ein Hilfethema in WinHelp bietet. Objekte sind nicht erforderlich, um IAccessible::get_accHelp und IAccessible::get_accHelpTopic zu unterstützen, aber sie müssen mindestens eine unterstützen. Wenn sie problemlos eine Zeichenfolge zurückgeben, müssen sie IAccessible::get_accHelp unterstützen. andernfalls muss IAccessible::get_accHelpTopic unterstützt werden. Wenn beides unterstützt wird, stellt IAccessible::get_accHelpTopic ausführlichere Informationen bereit.

Serverbeispiel

Der folgende Beispielcode zeigt eine mögliche Implementierung dieser Methode für ein benutzerdefiniertes Listenfeld. Je nach status des Kontakts in der Liste wird unterschiedlicher Text angezeigt. Der Einfachheit halber lokalisiert das Beispiel die zurückgegebene Zeichenfolge nicht.


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

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