attribut helpstring

  • Article

L’attribut [helpstring] spécifie une chaîne de caractères utilisée pour décrire l’élément auquel il s’applique. Vous pouvez appliquer l’attribut [helpstring] aux instructions library, importlib, interface, dispinterface, module ou coclass, typedefs, propriétés et méthodes.

[
    helpstring(help-text-string)
    [, optional-attribute-list]
] 
element element-name
{
    definition
}

[idl-statement, helpstring(help-text-string)]

Paramètres

help-text-string

Chaîne de caractères sans fin contenant du texte d’aide.

optional-attribute-list

Zéro ou plusieurs instructions d’attribut MIDL.

Élément

Une des directives suivantes : library, [importlib], interface, dispinterface, module, typedef, method, property ou coclass.

element-name

Nom que d’autres composants logiciels peuvent utiliser pour délimiter l’élément actuel

définition

Spécifie les instructions qui composent la définition d’élément.

idl-statement

Instruction de définition d’interface MIDL telle que propget ou propput.

Notes

Utilisez les fonctions GetDocumentation dans les interfaces ITypeLib et ITypeInfo pour récupérer la chaîne d’aide.

Exemples

[
    uuid(1e196b20-1f3c-1069-996b-00dd010fe676),
    helpstring("Lines 1.0 Type Library"),
    version(1.0)
]
library Lines
{
     [
         uuid(1e123456-1f3c-1069-996b-00dd010fe676), 
         helpstring("Line object."),
         oleautomation,
         dual
     ]
     interface ILine : IDispatch                         
     {
         [propget, helpstring("Returns and sets RGB color.")]
         HRESULT Color([out, retval] long* ReturnVal); 
         [propput, helpstring("Returns and sets RGB color.")]
         HRESULT Color([in] long rgb);
     }
};

Voir aussi

Bibliothèque

importlib

Interface

dispinterface

Module

coclasse

Typedef

Syntaxe de fichier ODL

Exemple de fichier ODL

Génération d’une bibliothèque de types avec MIDL