StockMaterialLibrary.importStockMaterial Method

Parent Object: StockMaterialLibrary

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/StockMaterials/StockMaterialLibrary.h>

Description

Import a given stockMaterial at a specific location. The stockMaterial will be stored in the library. Throws an error, if the given URL is read-only.

Syntax

"stockMaterialLibrary_var" is a variable referencing a StockMaterialLibrary object.
returnValue = stockMaterialLibrary_var.importStockMaterial(stockMaterial, destinationUrl, stockMaterialName)
"stockMaterialLibrary_var" is a variable referencing a StockMaterialLibrary object.

#include <Cam/StockMaterials/StockMaterialLibrary.h>

returnValue = stockMaterialLibrary_var->importStockMaterial(stockMaterial, destinationUrl, stockMaterialName);

Return Value

Type Description
URL Returns the URL of the newly imported stockMaterial, or null if the import failed.

Parameters

Name Type Description
stockMaterial StockMaterial The stockMaterial that should be imported.
destinationUrl URL The URL to the folder where to save the stockMaterial.
stockMaterialName string The name of the stockMaterial that should be created due to the import. The name can be extended if the asset already exists at given location to ensure a unique name.

Version

Introduced in version September 2024