Méthode IAccessible ::get_accHelp (oleacc.h)

Article
02/29/2024

La méthode IAccessible ::get_accHelp récupère la chaîne de propriété Help d’un objet. Tous les objets ne prennent pas en charge cette propriété.

Syntaxe

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

Paramètres

[in] varChild

Type : VARIANT

Spécifie si les informations d’aide récupérées appartiennent à l’objet ou à l’un des éléments enfants de l’objet. Ce paramètre est soit CHILDID_SELF (pour obtenir des informations sur l’objet) soit un ID enfant (pour obtenir des informations sur l’un des éléments enfants de l’objet). Pour plus d’informations sur l’initialisation du VARIANT, consultez Utilisation des ID enfants dans les paramètres.

[out, retval] pszHelp

Type : BSTR*

Adresse d’un BSTR qui reçoit la chaîne localisée contenant les informations d’aide pour l’objet spécifié, ou NULL si aucune information d’aide n’est disponible.

Valeur retournée

Type : HRESULT

En cas de réussite, retourne S_OK.

En cas de non-réussite, retourne l’une des valeurs de la table qui suit ou un autre code d’erreur COM standard. Les serveurs retournent ces valeurs, mais les clients doivent toujours case activée paramètres de sortie pour s’assurer qu’ils contiennent des valeurs valides. Pour plus d’informations, consultez Vérification des valeurs de retour IAccessibles.

Erreur	Description
S_FALSE	Aucune information d’aide n’est disponible.
E_INVALIDARG	Un argument n’est pas valide.
DISP_E_MEMBERNOTFOUND	L’objet ne prend pas en charge cette propriété.

Remarques

Aucun des contrôles prédéfinis et courants ne prend en charge cette propriété.

Remarque aux développeurs de serveurs : Localisez la chaîne retournée à partir de cette propriété.

Cette propriété retourne une chaîne, tandis que IAccessible ::get_accHelpTopic permet d’accéder à une rubrique d’aide dans WinHelp. Les objets ne sont pas nécessaires pour prendre en charge IAccessible ::get_accHelp et IAccessible ::get_accHelpTopic, mais ils doivent en prendre en charge au moins un. S’ils retournent facilement une chaîne, ils doivent prendre en charge IAccessible ::get_accHelp ; sinon, ils doivent prendre en charge IAccessible ::get_accHelpTopic. Si les deux sont pris en charge, IAccessible ::get_accHelpTopic fournit des informations plus détaillées.

Exemple de serveur

L’exemple de code suivant montre une implémentation possible de cette méthode pour une zone de liste personnalisée. Un texte différent s’affiche en fonction de la status du contact dans la liste. Par souci de simplicité, l’exemple ne localise pas la chaîne retournée.


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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	oleacc.h
Bibliothèque	Oleacc.lib
DLL	Oleacc.dll
Composant redistribuable	Active Accessibility 1.3 RDK sur Windows NT 4.0 avec SP6 et versions ultérieures et Windows 95