Méthode ICreateTypeLib ::SetHelpFileName (oaidl.h)

  • Article

Définit le nom du fichier d’aide.

Syntaxe

HRESULT SetHelpFileName(
  [in] LPOLESTR szHelpFileName
);

Paramètres

[in] szHelpFileName

Nom du fichier d’aide de la bibliothèque.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour Description
S_OK
 Réussite.
E_INVALIDARG
 Un ou plusieurs arguments ne sont pas valides.
E_OUTOFMEMORY
 Mémoire insuffisante pour terminer l’opération.
STG_E_INSUFFICIENTMEMORY
 Mémoire insuffisante pour terminer l’opération.
TYPE_E_INVALIDSTATE
 L’état de la bibliothèque de types n’est pas valide pour cette opération.

Remarques

Chaque bibliothèque de types peut référencer un seul fichier d’aide.

La méthode GetDocumentation de l’ITypeLib créé retourne un chemin complet pour le fichier d’aide, qui est formé en ajoutant le nom passé dans szHelpFileName au répertoire d’aide inscrit pour la bibliothèque de types. Le répertoire d’aide est inscrit sous :

\TYPELIB< ; guid de la bibliothèque>< ; Major.Minor version >\HELPDIR

Configuration requise

Condition requise Valeur
Plateforme cible Windows
En-tête oaidl.h

Voir aussi

ICreateTypeLib