GetSnapshots()
Summary
Gets a list of all snapshots associated with a map.
Syntax
snapshot_names = GetSnapshots(string map_name)
| Argument | Contents |
|---|---|
| map_name | Name of a map, or null for the current map |
Returns
An array of strings containing the names of all snapshots.
Example
snap_list = GetSnapshots("United States Map")
ShowMessage("There are " + String(snap_list.length) + " snapshots.")Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified map or snapshots do not exist. |
See Also
| Function | Summary |
|---|---|
| CreateSnapshot() | Stores a snapshot image of the map as currently displayed |
| ShowSnapshot() | Displays a snapshot and sets the map scope to match |
| GetSnapshot() | Gets a list of all snapshots associated with a map |
| ConstructSnapshot() | Converts a customized image file into a map snapshot |
| DeleteSnapshot() | Removes a snapshot from a map and deletes its image file |