Tool.description Property

Parent Object: Tool
Defined in namespace "adsk::cam" and the header file is <Cam/Tools/Tool.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

"tool_var" is a variable referencing a Tool object.

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

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

Property Value

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

Version

Introduced in version January 2026