ConfigurationJointSnaps.itemByName Method

Parent Object: ConfigurationJointSnaps

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/Configurations/ConfigurationJointSnaps.h>

Description

A method that returns the snap with the specified name.

Syntax

"configurationJointSnaps_var" is a variable referencing a ConfigurationJointSnaps object.
returnValue = configurationJointSnaps_var.itemByName(name)
"configurationJointSnaps_var" is a variable referencing a ConfigurationJointSnaps object.

#include <Fusion/Configurations/ConfigurationJointSnaps.h>

returnValue = configurationJointSnaps_var->itemByName(name);

Return Value

Type Description
ConfigurationJointSnap Returns the specified snap or null if a snap with the specified name does not exist.

Parameters

Name Type Description
name string The name of the snap to return.

Version

Introduced in version September 2024