DocumentToolLibrary.toolsBySetupOrFolder Method

Parent Object: DocumentToolLibrary

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/DocumentToolLibrary.h>

Description

Returns all tools used in a given setup or folder. Given setup or folder must belong to the document of the DocumentToolLibrary. Raises an error if given operation is not in the document.

Syntax

"documentToolLibrary_var" is a variable referencing a DocumentToolLibrary object.
returnValue = documentToolLibrary_var.toolsBySetupOrFolder(setupOrFolder)
"documentToolLibrary_var" is a variable referencing a DocumentToolLibrary object.

#include <Cam/Tools/DocumentToolLibrary.h>

returnValue = documentToolLibrary_var->toolsBySetupOrFolder(setupOrFolder);

Return Value

Type Description
Tool[] Returns tools used by a specific setup or folder.

Parameters

Name Type Description
setupOrFolder OperationBase The setup or folder to get tools from. Must belong to the document.

Version

Introduced in version July 2023