Partager via

ICreateTypeInfo ::SetFuncDocString, méthode (oaidl.h)

  • Article

Définit la chaîne de documentation de la fonction avec l’index spécifié.

Syntaxe

HRESULT SetFuncDocString(
  [in] UINT     index,
  [in] LPOLESTR szDocString
);

Paramètres

[in] index

Index de la fonction.

[in] szDocString

Chaîne de documentation.

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.
E_ACCESSDENIED
 Impossible d’écrire dans la destination.
STG_E_INSUFFICIENTMEMORY
Mémoire insuffisante pour terminer l’opération.
TYPE_E_ELEMENTNOTFOUND
 L’élément est introuvable.

Remarques

La chaîne de documentation est une brève description de la fonction destinée à être utilisée par des outils tels que les navigateurs de type. SetFuncDocString ne doit être utilisé qu’une seule fois pour chaque propriété, car toutes les fonctions d’accesseur de propriété sont identifiées par un seul nom.

Configuration requise

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

Voir aussi

ICreateTypeInfo