ToolBlock.description Property

Parent Object: ToolBlock

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::cam" and the header file is <Cam/Tools/ToolBlock.h>

Description

Gets the descriptive text about the tool. Includes various pieces of information depending on the tool type. Usually contains the tool number, data describing the tool geometry and the description. In the UI, the same information is displayed in the operation tree or in the tool library table.

Syntax

"toolBlock_var" is a variable referencing a ToolBlock object.

# Get the value of the property.
propertyValue = toolBlock_var.description
"toolBlock_var" is a variable referencing a ToolBlock object.
#include <Cam/Tools/ToolBlock.h>

// Get the value of the property.
string propertyValue = toolBlock_var->description();

Property Value

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

Version

Introduced in version April 2026