Méthode ITypeInfo ::GetDocumentation (oaidl.h)

Récupère la chaîne de documentation, le nom et le chemin d'accès complets du fichier d'aide et l'ID de contexte de la rubrique d'aide se rapportant à une description de type spécifiée.

Syntaxe

HRESULT GetDocumentation(
  [in]  MEMBERID memid,
  [out] BSTR     *pBstrName,
  [out] BSTR     *pBstrDocString,
  [out] DWORD    *pdwHelpContext,
  [out] BSTR     *pBstrHelpFile
);

Paramètres

[in] memid

ID du membre dont la documentation doit être retournée.

[out] pBstrName

Nom de l’élément spécifié. Si l’appelant n’a pas besoin du nom de l’élément, pBstrName peut être null.

[out] pBstrDocString

Chaîne de documentation pour l’élément spécifié. Si l’appelant n’a pas besoin de la chaîne de documentation, pBstrDocString peut être null.

[out] pdwHelpContext

Contexte de localisation de l’aide. Si l’appelant n’a pas besoin du contexte d’aide, il peut être null.

[out] pBstrHelpFile

Nom complet du fichier contenant la DLL utilisée pour le fichier d’aide. Si l’appelant n’a pas besoin du nom de fichier, il peut être null.

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.

Remarques

La fonction GetDocumentation permet d’accéder à la documentation du membre spécifié par le paramètre memid . Si le memid transmis est MEMBERID_NIL, la documentation relative à la description du type est retournée.

Si la description de type hérite d’une autre description de type, cette fonction est récursive à la description de type de base, si nécessaire, pour rechercher l’élément avec l’ID de membre demandé.

L’appelant doit utiliser SysFreeString pour libérer les BSTR référencés par pBstrName, pBstrDocString et pBstrHelpFile.

Configuration requise

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

Voir aussi

ITypeInfo