AddExistingLayer()

Summary

Adds an existing layer in the workspace to a map.

Syntax

actual_lyr_name = AddExistingLayer(string map_name, string layer_name)

Returns

A string indicating the actual name of the layer, which is identical to layer_name unless the layer name is already in use.

Notes

• If the map_name is null, AddExistingLayer() adds the layer to the current map.

• Adding a layer to a map does not set any display characteristics for the layer. In other words, the layer is not visible until display colors and styles are assigned. Default display settings can be made with the New Layer Default Settings Standard Interface Macro.

• Maptitude tracks geographic files and their layer names across the entire workspace, not just within individual map and dataview windows. While the same geographic file can have identical layer names in different maps, different geographic files cannot share the same layer name, even if they reside in separate maps. When a naming conflict occurs, Maptitude automatically appends a colon and sequence number to the layer name to ensure uniqueness.

Example

// Before running the example, create a map by opening nesouth.cdf
// and a second map by opening ne_plc.cdf, both in the Tutorial folder.
lyr_info = GetLayers()
if lyr_info[3] <> null then do
// Add the current layer to another map
new_lyr = AddExistingLayer("U.S. Counties", lyr_info[3])
SetMap("U.S. Counties")
RunMacro("G30 new layer default settings", new_lyr)
end

Error Codes

See Also