helpstring-Attribut
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 Bibliotheks-, Importlib-, Schnittstellen-, Dispinterface-, Modul- oder Coclass-Anweisungen, TypeDefs, Eigenschaften und Methoden anwenden.
[
helpstring(help-text-string)
[, optional-attribute-list]
]
element element-name
{
definition
}
[idl-statement, helpstring(help-text-string)]
Parameter
-
help-text-string
-
Eine auf null endende Zeichenfolge von Zeichen, die Hilfetext enthält.
-
optional-attribute-list
-
Null oder mehr MIDL-Attributanweisungen.
-
Element
-
Eine der folgenden Direktiven: bibliothek, [ importlib, ] interface, dispinterface, module, typedef, method, property oder coclass.
-
Elementname
-
Der Name, den andere Softwarekomponenten verwenden können, um das aktuelle Element abzugrenzen
-
Definition
-
Gibt Anweisungen an, die die Elementdefinition bilden.
-
idl-statement
-
Eine MIDL-Schnittstellendefinitions-Anweisung wie propget oder propput.
Bemerkungen
Verwenden Sie die GetDocumentation-Funktionen in den Schnittstellen ITypeLib und ITypeInfo, 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);
}
};