UserParameter.comment Property

Parent Object: UserParameter
Defined in namespace "adsk::fusion" and the header file is <Fusion/Fusion/UserParameter.h>

Description

The comment associated with this parameter

Syntax

"userParameter_var" is a variable referencing a UserParameter object.

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

# Set the value of the property.
userParameter_var.comment = propertyValue
"userParameter_var" is a variable referencing a UserParameter object.
#include <Fusion/Fusion/UserParameter.h>

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

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

Property Value

This is a read/write property whose value is a string.

Version

Introduced in version August 2014