Méthode ITypeLib2 ::GetDocumentation2 (oaidl.h)

Article
03/04/2024

Récupère la chaîne de documentation de la bibliothèque, le nom de fichier complet et chemin d’accès, le contexte de localisation à utiliser et l’ID de contexte pour la rubrique d’aide de bibliothèque dans le fichier d’aide.

Syntaxe

HRESULT GetDocumentation2(
  [in]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

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 est retournée.

[in] lcid

Identificateur de paramètres régionaux.

[out] pbstrHelpString

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

[out] pdwHelpStringContext

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

[out] pbstrHelpStringDll

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.
STG_E_INSUFFICIENTMEMORY	Mémoire insuffisante pour terminer l’opération.

Remarques

Obtient des informations au niveau de la bibliothèque de types. L’appelant doit libérer les paramètres BSTR.

Cette fonction appelle _DLLGetDocumentation dans la DLL spécifiée pour récupérer la chaîne d’aide souhaitée, s’il existe un contexte de chaîne d’aide pour cet élément. S’il n’existe aucun contexte de chaîne d’aide ou qu’une erreur se produit, celle-ci se reporte à la méthode GetDocumentation et retourne la chaîne de documentation associée.

Configuration requise

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

Voir aussi

ITypeLib2

Partager via