GetLayoutFile()

Summary

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

 

Syntax

file = GetLayoutFile(string layout_name)

 

Argument	Contents
layout_name	The name of the layout, or null for the current layout.

 

Returns

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

 

Example

// Display the source of a layout

file = GetLayoutFile("Page Spread")

ShowMessage("The page spread layout is from the file: " + file)

 

Error Codes

Error Type	Meaning
NotFound	The specified layout does not exist

 

See Also

Function	Summary
SaveLayout()	Saves a layout to a file
OpenLayout()	Creates a layout from a file
GetLayoutSaveFlag()	Determines whether a layout has changed since it was last saved to a file