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

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

Syntaxe

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

Paramètres

[in] memid

L’identificateur du membre pour le type de description.

[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 avoir la valeur 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.

Remarques

Obtient des informations au niveau des informations de type (sur les informations de type et ses membres). 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 si une erreur se produit, il se reporte à la méthode GetDocumentation et retourne la chaîne de documentation associée.

Configuration requise

Voir aussi

ITypeInfo2