Partager via


Méthode IPropertyPage ::Help (ocidl.h)

Appelle l’aide de la page de propriétés en réponse à une demande de l’utilisateur final.

Syntaxe

HRESULT Help(
  [in] LPCOLESTR pszHelpDir
);

Paramètres

[in] pszHelpDir

Pointeur vers la chaîne sous la clé HelpDir dans les informations CLSID de la page de propriétés dans le Registre. Si HelpDir n’existe pas, il s’agit du chemin d’accès trouvé dans l’entrée InprocServer32 moins le nom de fichier du serveur. (Notez que LocalServer32 n’est pas coché, car les pages de propriétés locales ne sont pas prises en charge).

Valeur retournée

Cette méthode peut retourner les valeurs de retour standard E_OUTOFMEMORY et E_UNEXPECTED, ainsi que les valeurs suivantes.

Code de retour Description
S_OK
La page affichait sa propre aide.
E_NOTIMPL
L’aide n’est pas fournie ou est fournie uniquement par le biais de l’information PROPPAGEINFO.

Remarques

Remarques aux appelants

Les appels à cette méthode doivent se produire entre les appels à IPropertyPage ::Activate et IPropertyPage ::D eactivate.

Remarques aux implémenteurs

Si la page échoue à cette méthode (telle que E_NOTIMPL), le cadre tente d’utiliser les membres pszHelpFile et dwHelpContext de la structure PROPPAGEINFO obtenues via IPropertyPage ::GetPageInfo. Par conséquent, la page doit implémenter IPropertyPage ::Help ou retourner des informations d’aide via IPropertyPage ::GetPageInfo.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête ocidl.h

Voir aussi

IPropertyPage

PROPPAGEINFO