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

Article
08/25/2023

La méthode IAccessible::get_accDefaultAction récupère une chaîne qui indique l’action par défaut de l’objet. Les objets n'ont pas tous une action par défaut.

Syntaxe

HRESULT get_accDefaultAction(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszDefaultAction
);

Paramètres

[in] varChild

Type : VARIANT

Spécifie si l’action par défaut récupérée est effectuée par l’objet ou par l’un des éléments enfants de l’objet. Ce paramètre est CHILDID_SELF (pour obtenir des informations sur l’objet) ou un ID enfant (pour obtenir des informations sur l’élément enfant de l’objet). Pour plus d’informations sur l’initialisation de la structure VARIANT, consultez Utilisation des ID enfants dans les paramètres.

[out, retval] pszDefaultAction

Type : BSTR*

Adresse d’un BSTR qui reçoit une chaîne localisée qui décrit l’action par défaut pour l’objet spécifié ; si cet objet n’a aucune action par défaut, la valeur est NULL.

Valeur retournée

Type : HRESULT

En cas de réussite, retourne S_OK.

En cas d’erreur, 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 IAccessible.

Erreur	Description
S_FALSE	L’objet spécifié n’a pas d’action par défaut.
E_INVALIDARG	Un argument n’est pas valide.
DISP_E_MEMBERNOTFOUND	L’objet spécifié ne prend pas en charge cette propriété.

Notes

La chaîne récupérée décrit l’action qui est effectuée sur un objet, et non ce que l’objet fait en conséquence. Par exemple, un bouton de barre d’outils qui imprime un document a l’action par défaut « Appuyez » au lieu de « Imprime le document actif ».

Ne confondez pas l’action par défaut d’un objet avec sa valeur. Pour plus d’informations, consultez Propriété DefaultAction.

Seuls les contrôles qui effectuent des actions prennent en charge cette méthode.

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

Exemple de serveur

L’exemple de code suivant montre une implémentation possible de cette méthode pour une zone de liste personnalisée. Par souci de simplicité, les chaînes ne sont pas localisées.


HRESULT STDMETHODCALLTYPE AccServer::get_accDefaultAction( 
    VARIANT varChild,
    BSTR *pszDefaultAction)
{
    if (varChild.vt != VT_I4)
    {
        *pszDefaultAction = NULL;
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszDefaultAction = SysAllocString(L"None.");
    }
    else
    {
        *pszDefaultAction = SysAllocString(L"Double-click");
    }
    return S_OK;
};

Spécifications


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