atributo helpstring
El atributo [helpstring] especifica una cadena de caracteres que se usa para describir el elemento al que se aplica. Puede aplicar el atributo [helpstring] a instrucciones library, importlib, interface, dispinterface, module o coclass, typedefs, properties y methods.
[
helpstring(help-text-string)
[, optional-attribute-list]
]
element element-name
{
definition
}
[idl-statement, helpstring(help-text-string)]
Parámetros
-
help-text-string
-
Cadena terminada en cero de caracteres que contienen texto de ayuda.
-
optional-attribute-list
-
Cero o más instrucciones de atributo MIDL.
-
element
-
Una de las siguientes directivas: library, [importlib], interface, dispinterface, module, typedef, method, property o coclass.
-
element-name
-
Nombre que otros componentes de software pueden usar para delinear el elemento actual
-
definition
-
Especifica instrucciones que componen la definición de elemento.
-
idl-statement
-
Una instrucción de definición de interfaz MIDL, como propget o propput.
Observaciones
Use las funciones GetDocumentation en las interfaces ITypeLib e ITypeInfo para recuperar la cadena de ayuda.
Ejemplos
[
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);
}
};
Vea también