GetFigureFile()

Summary

Gets the name of the file in which a figure was last saved.

 

Syntax

file = GetFigureFile(string figure_name)

 

Argument	Contents
figure_name	The name of the figure, or null for the current figure.

 

Returns

A string indicating the name of the file from which the figure was loaded, or to which to figure was most recently saved. If the figure has never been saved to a file, GetFigureFile() returns null.

 

Example

// Display the source of a figure

file = GetFigureFile("Prism Map")

ShowMessage("The prism map figure is from the file: " + file)

 

Error Codes

Error Type	Meaning
NotFound	The specified figure does not exist

 

See Also

Function	Summary
SaveFigure()	Saves a figure to a file
OpenFigure()	Creates a figure from a file
GetFigureSaveFlag()	Determines whether a figure has changed since it was last saved to a file