ConfigurationRule.comment Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Gets and sets the optional comment attached to this rule. Empty when no comment has been set. Use this for the rule's purpose; use ConfigurationRuleCommentBlock entries inside the body to document individual sections of the body.

Syntax

# Get the value of the property.
propertyValue = configurationRule_var.comment

# Set the value of the property.
configurationRule_var.comment = propertyValue

#include <Fusion/ConfigurationRules/ConfigurationRule.h>

// Get the value of the property.
string propertyValue = configurationRule_var->comment();

// Set the value of the property, where value_var is a string.
bool returnValue = configurationRule_var->comment(value_var);

// Get the value of the property.
propertyValue = configurationRule_var.comment;

// Set the value of the property.
configurationRule_var.comment = propertyValue;

Property Value

Version