class Parameter

Sets the class to which the current line belongs.

Scope: Line

Syntax

query class 
set class ClassName [ClassName] [...] 

Option

ClassName 
A string of one or more classes separated by blanks. All classes in the list must have been already defined with the set classes parameter.

Description

The class parameter sets the classes to which the current line belongs (for example, FUNCTION and COMMENT in C++).

Examples

  1. To discover which class the current line belongs to, type:
    query class 
  2. To set the current line in C++ to the COMMENTS class, type:
    set class comments 

API Return Codes

1 
The specified ClassName was not a valid class type. Use the query classes command to see which class names are currently defined, or use the set class command to define a new class. Issue the command again using one or more valid ClassNames.
-2 
At least one ClassName option must be present. Issue the set class command again specifying a valid ClassName.
-5 
You cannot make changes to the file because the readonly parameter is set to on.

classes Parameter