SchematicDocument.saveAs Method

This 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.

Description

Performs a Save As on this document. This saves the currently open document to the specified location and this document becomes the saved document. If this is a new document that has never been saved you must use the SaveAs method in order to specify the location and name. You can determine if the document has been saved by checking the value of the isSaved property.

Saving a document is not supported within any of the Command related events. When a command is running, a transaction is open, and saving a document cannot be transacted and, as a result, cannot be contained within a command transaction.

Syntax

returnValue = schematicDocument_var.saveAs(name, dataFolder, description, tag)

#include <Electron/SchematicDocument/SchematicDocument.h>

returnValue = schematicDocument_var->saveAs(name, dataFolder, description, tag);

returnValue = schematicDocument_var.saveAs(name, dataFolder, description, tag);

Return Value

Parameters

Version