atributo helpstring

  • Artigo

O atributo [helpstring] especifica uma cadeia de caracteres usada para descrever o elemento ao qual ele se aplica. Você pode aplicar o atributo [helpstring] a instruções library, importlib, interface, dispinterface, module ou coclass, typedefs, properties e methods.

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

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

Parâmetros

help-text-string

Uma cadeia de caracteres com terminação zero de caracteres que contém texto de ajuda.

optional-attribute-list

Zero ou mais instruções de atributo MIDL.

element

Uma das seguintes diretivas: library, [importlib], interface, dispinterface, module, typedef, method, property ou coclass.

element-name

O nome que outros componentes de software podem usar para delinear o elemento atual

definição

Especifica instruções que compõem a definição do elemento.

instrução idl

Uma instrução de definição de interface MIDL, como propget ou propput.

Comentários

Use as funções GetDocumentation nas interfaces ITypeLib e ITypeInfo para recuperar a cadeia de caracteres de ajuda.

Exemplos

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

Confira também

biblioteca

importlib

Interface

dispinterface

Módulo

coclass

Typedef

Sintaxe de arquivo ODL

Exemplo de arquivo ODL

Gerando uma biblioteca de tipos com MIDL