helpstring

 

The latest version of this topic can be found at helpstring.

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

Syntax

  
      [ 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

IDL Attributes
Interface Attributes
Class Attributes
Method Attributes
Typedef, Enum, Union, and Struct Attributes
helpfile
helpcontext
Attributes Samples