Leggere in inglese

Condividi tramite


Attributo helpstring

L'attributo [helpstring] specifica una stringa di caratteri utilizzata per descrivere l'elemento a cui si applica. È possibile applicare l'attributo [helpstring] alle istruzioni library, importlib, interface, dispinterface, module o coclass, typedef, proprietà e metodi.

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

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

Parametri

help-text-string

Stringa con terminazione zero di caratteri contenente il testo della Guida.

optional-attribute-list

Zero o più istruzioni di attributo MIDL.

Elemento

Una delle direttive seguenti: library, [importlib], interface, dispinterface, module, typedef, method, property o coclass.

element-name

Nome che altri componenti software possono usare per delineare l'elemento corrente

Definizione

Specifica le istruzioni che costituiscono la definizione dell'elemento.

istruzione idl

Istruzione di definizione dell'interfaccia MIDL, ad esempio propget o propput.

Commenti

Usare le funzioni GetDocumentation nelle interfacce ITypeLib e ITypeInfo per recuperare la stringa della Guida.

Esempi

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

Vedere anche

library

importlib

Interfaccia

dispinterface

Modulo

coclass

Typedef

Sintassi dei file ODL

Esempio di file ODL

Generazione di una libreria dei tipi con MIDL