ParameterList.itemByName Method

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

Description

Returns the specified parameter using the name of the parameter as it is displayed in the parameters dialog.

Syntax

"parameterList_var" is a variable referencing a ParameterList object.

returnValue = parameterList_var.itemByName(name)
"parameterList_var" is a variable referencing a ParameterList object.

#include <Fusion/Fusion/ParameterList.h>

returnValue = parameterList_var->itemByName(name);
"parameterList_var" is a variable referencing a ParameterList object.

returnValue = parameterList_var.itemByName(name);

Return Value

Type Description
Parameter Returns the specified item or null if an invalid name was specified.

Parameters

Name Type Description
name string The name of the parameter as it is displayed in the parameters dialog.

Samples

Name Description
Create Animation API Sample

Creates a series of images while a design parameter changes. You can assemble the images into an animation in other software.

Before running: Open a part that contains a user or model parameter named Length, modifiable from 10 to 15 centimeters. When prompted, choose or create an output folder; the script saves one image per parameter value.

Version

Introduced in version August 2014