Атрибут helpstring
Атрибут [helpstring] задает строку символов, используемую для описания элемента, к которому она применяется. Атрибут [helpstring] можно применить к операторам library, importlib, interface, dispinterface, module или coclass, typedefs, properties и methods.
[
helpstring(help-text-string)
[, optional-attribute-list]
]
element element-name
{
definition
}
[idl-statement, helpstring(help-text-string)]
Параметры
-
help-text-string
-
Строка символов с нулем, содержащая текст справки.
-
optional-attribute-list
-
Ноль или несколько операторов атрибутов MIDL.
-
Элемент
-
Одна из следующих директив: library, [importlib], interface, dispinterface, module, typedef, method, property или coclass.
-
element-name
-
Имя, которое другие компоненты программного обеспечения могут использовать для разграничения текущего элемента.
-
definition
-
Указывает операторы, составляющие определение элемента.
-
idl-statement
-
Оператор определения интерфейса MIDL, например propget или propput.
Комментарии
Используйте функции GetDocumentation в интерфейсах ITypeLib и ITypeInfo , чтобы получить строку справки.
Примеры
[
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);
}
};
См. также раздел