GetRecordScope()

Summary

Gets the scope of a given record on the current layer.

Syntax

record_scope = GetRecordScope(string record_handle)

Argument Contents
record_handle A record handle for a record in the current layer

Returns

The scope of the record.

Notes

  • GetRecordScope() works only on the current layer. The input record must be a record on the current layer.

  • The current layer must be a point, line or area layer. It cannot be an image layer.

  • For a full list of scope-related GISDK functions, see Map Scales and Scopes.

Example

//Open BDOCUMENTS\CALIPER\\< product name>\TUTORIAL\NElayers.wrkz
tutorial_folder = RunMacro("G30 Tutorial Folder")
wrkz = OpenWorkspace(tutorial_folder + "NElayers.wrkz")rh = LocateRecord("County|", "[County Name]", {"SUFFOLK MA"}, )
SetMapScope(, GetRecordScope(rh))
RedrawMap()

Error Codes

Error Type Meaning
NotFound There is no current layer; the current layer is not a point, line or area layer; the record handle does not correspond to a record on the current layer; or the record_handle is null.

See Also

Function Summary
GetSetScope() Gets the scope of the features in a selection set
GetLayerScope() Gets the scope of a layer