SaveMap()

Summary

Saves settings for a map window to a file on disk.

 

Syntax

SaveMap(string map_name, string path [, array options])

 

Argument	Contents
map_name	The name of the map, or null for the current map
path	The path and file name in which to save the map, or null to save the map to the file either from which it was opened or to which it was most recently saved

 

Option	Type	Contents
Header Data	Any	A value to store in the file header, including an array

 

Notes

• The options array is an optional argument.

Example

SaveMap("My First Map", "c:\\mymap.map")

 

// HeaderData variable defined previously

SaveMap( , "c:\\mymap1.map", {{"Header Data", HeaderData}})

 

Error Codes

Error Type	Meaning
Error	Unable to create the map file (e.g., out of disk space, the drive or directory is read only)
NotFound	There is no map with the specified name, or path is null and the map was not previously saved to a file

 

See Also

Function	Summary
DuplicateMap()	Creates a copy of a map
GetMapFile()	Gets the name of the file in which a map was last saved
GetMapSaveFlag()	Determines whether a map has changed since it was last saved to a file
OpenMap()	Opens a map file and displays it in a map window