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

Article
02/29/2024

La méthode IAccessible ::get_accHelpTopic récupère le chemin d’accès complet du fichier WinHelp associé à l’objet spécifié ; il récupère également l’identificateur de la rubrique appropriée dans ce fichier. Tous les objets ne prennent pas en charge cette propriété. Cette propriété est rarement prise en charge ou utilisée par les applications

RemarqueIAccessible ::get_accHelpTopic est déconseillé et ne doit pas être utilisé.

Syntaxe

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

Paramètres

[out] pszHelpFile

Type : BSTR*

Adresse d’un BSTR qui reçoit le chemin d’accès complet du fichier WinHelp associé à l’objet spécifié.

[in] varChild

Type : VARIANT

Spécifie si la rubrique d’aide récupérée appartient à l’objet ou à l’un des éléments enfants de l’objet. Ce paramètre est soit CHILDID_SELF (pour obtenir une rubrique d’aide pour l’objet) soit un ID enfant (pour obtenir une rubrique d’aide pour 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.

pidTopic

Type : long*

[out, retval] Adresse d’une variable qui identifie la rubrique de fichier d’aide associée à l’objet spécifié. Cette valeur est utilisée comme identificateur de contexte de la rubrique souhaitée qui passe à la fonction WinHelp . Lorsque vous appelez WinHelp pour afficher la rubrique, définissez le paramètre uCommand sur HELP_CONTEXT, castez la valeur pointée par pidTopic en DWORD et passez-la en tant que paramètre dwData .

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

L’obtention d’informations à partir d’un fichier d’aide peut prendre beaucoup de temps et de mémoire.

Remarque aux développeurs de serveurs : Cette propriété permet d’accéder à une rubrique d’aide dans WinHelp, tandis que IAccessible ::get_accHelp retourne une chaîne. 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 peuvent facilement retourner 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.

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

Voir aussi

HelpTopic, propriété

Iaccessible

IAccessible ::get_accHelp

Partager via