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

Article
03/04/2024

Récupère la chaîne de documentation de la bibliothèque, le nom et le chemin d’accès complets du fichier d’aide, ainsi que l’identificateur de contexte de la rubrique d’aide de la bibliothèque dans le fichier d’aide.

Syntaxe

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

Paramètres

[in] index

Index de la description de type dont la documentation doit être retournée. Si index a la valeur -1, la documentation de la bibliothèque elle-même est 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

Identificateur de contexte d’aide (ID) associé à l’élément spécifié. Si l’appelant n’a pas besoin de l’ID de contexte d’aide, pdwHelpContext peut être null.

[out] pBstrHelpFile

Nom complet du fichier d’aide. Si l’appelant n’a pas besoin du nom du fichier d’aide, pBstrHelpFile 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.
STG_E_INSUFFICIENTMEMORY	Mémoire insuffisante pour terminer l’opération.

Remarques

L’appelant doit libérer les paramètres pBstrName, pBstrDocString et pBstrHelpFile.

Configuration requise

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

Voir aussi

ITypeLib

Partager via