helpstring-Attribut

Artikel
06/13/2023

Das [helpstring] -Attribut gibt eine Zeichenfolge an, die verwendet wird, um das Element zu beschreiben, auf das es angewendet wird. Sie können das [helpstring] -Attribut auf die Anweisungen library, importlib, interface, dispinterface, module oder coclass, typedefs, properties und methods anwenden.

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

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

Parameter

help-text-string: Eine Zeichenfolge mit Nullzeichen, die Hilfetext enthält.
optional-attribute-list: Null oder mehr MIDL-Attributanweisungen.
Element: Eine der folgenden Anweisungen: library, [importlib], interface, dispinterface, module, typedef, method, property, or coclass.
Elementname: Der Name, den andere Softwarekomponenten verwenden können, um das aktuelle Element abzugrenzen.
definition: Gibt Anweisungen an, aus denen die Elementdefinition besteht.
idl-anweisung: Eine MIDL-Schnittstellendefinitionsanweisung wie Propget oder Propput.

Bemerkungen

Verwenden Sie die GetDocumentation-Funktionen in der ITypeLib - und ITypeInfo-Schnittstelle , um die Hilfezeichenfolge abzurufen.

Beispiele

[
    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);
     }
};

Weitere Informationen

Bibliothek
importlib
Schnittstelle
Dispatchschnittstelle
Modul
coclass
Typedef
ODL-Dateisyntax
ODL-Dateibeispiel
Generieren einer Typbibliothek mit MIDL

Share via