GetFigureSaveFlag()

Summary

Determines whether a figure has changed since it was last saved to a file.

 

Syntax

flag = GetFigureSaveFlag(string figure_name)

 

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

 

Returns

The string "True" if the figure has changed and needs to be saved; the string "False" if it has not changed since it was last loaded from or saved to a file.

 

Notes

• The save flag is set automatically whenever the figure is changed, but the user is not prompted automatically when the figure is closed. Use GetFigureSaveFlag() to determine whether or not to prompt the user about saving the figure.

Example

if GetFigureSaveFlag() = "False" then goto ok_to_quit

// Prompt the user to save the contents before quitting...

 

Error Codes

Error Type	Meaning
NotFound	The specified figure window does not exist

 

See Also

Function	Summary
GetEditorSaveFlag()	Determines whether an editor has changed since it was last saved to a file
GetLayoutSaveFlag()	Determines whether a layout has changed since it was last saved to a file
GetMapSaveFlag()	Determines whether a map has changed since it was last saved to a file
SaveFigure()	Saves a figure to a file
OpenFigure()	Creates a figure from a file