helpstring

[helpstring( string )[, optional-attribute-list]] odl-statement

Example

  [uuid(. . .),helpstring("Lines 1.0 Type Library"),version(1.0)]

library Lines

{ 

     [uuid(. . .), helpstring("Line object."),oleautomation,dual]

    interface ILine : IDispatch                         

    { 

      [propget, helpstring("Returns and sets RGB color.")]

      HRESULT Color([out, retval] long* retval);

      [propput, helpstring("Returns and sets RGB color.")]

      HRESULT Color([in] long rgb);

     }

};

Remarks

The helpstring attribute specifies a character string that is used to describe the element to which it applies. You can apply the helpstring attribute to library, importlib, interface, dispinterface, module, or coclass statements, typedefs, properties, and methods.

Use the GetDocumentation functions in the ITypeLib and ITypeInfo interfaces to retrieve the help string.

See Also