ShowSnapshot()

Summary

Displays a snapshot and sets the map scope to match.

 

Syntax

ShowSnapshot(string map_name, string snapshot_name)

 

Argument	Contents
map_name	Name of the map, or null for the current map
snapshot_name	Name of the snapshot to show

 

Notes

• Snapshots allow you to save multiple map images and their associated scopes in a single map file and to switch between them quickly.

Example

// Accept a mouse click from the user & see what state he clicked in...

lyr = "State"

SetLayer(lyr)

rh = LocateNearestRecord(ClickCoord(), 25.0)

state_name = lyr.Name

 

// Now, display one of the 51 snapshots you have in the file

ShowSnapshot(null, state_name)

 

Error Codes

Error Type	Meaning
NotFound	The specified map or snapshot does not exist

 

See Also

Function	Summary
CreateSnapshot()	Stores a snapshot image of the map as currently displayed
GetSnapshot()	Gets the scope and image file of a snapshot
GetSnapshots()	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