helpstring

Specifies a character string that is used to describe the element to which it applies.

[ helpstring(
   "string"
) ]

Parameters

  • string
    The text of the help string.

Remarks

The helpstring C++ attribute has the same functionality as the helpstring MIDL attribute.

Example

See the example for defaultvalue for an example of how to use helpstring.

Requirements

Attribute Context

Applies to

interface, typedef, class, method, property

Repeatable

No

Required attributes

None

Invalid attributes

None

For more information, see Attribute Contexts.

See Also

Reference

helpfile

helpcontext

Other Resources

IDL Attributes

Interface Attributes

Class Attributes

Method Attributes

Typedef, Enum, Union, and Struct Attributes

Attributes Samples