CustomFeatureParameter.role Property

Parent Object: CustomFeatureParameter

PreviewThis 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.


Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/CustomFeatureParameter.h>

Description

This property identifies what the parameter is used for. For an extrude, it could be "Depth", for a work plane it could be "Offset".

Syntax

"customFeatureParameter_var" is a variable referencing a CustomFeatureParameter object.

# Get the value of the property.
propertyValue = customFeatureParameter_var.role
"customFeatureParameter_var" is a variable referencing a CustomFeatureParameter object.
#include <Fusion/Features/CustomFeatureParameter.h>

// Get the value of the property.
string propertyValue = customFeatureParameter_var->role();

Property Value

This is a read only property whose value is a string.

Version

Introduced in version January 2021