All Cadcorp SIS API Methods

ScanOverlay Method

Description

Scans an overlay for Items, storing any found in a Named List

Syntax

Visual Basic 
Public Function ScanOverlay( _
   ByVal list As String, _
   ByVal pos As Integer, _
   ByVal filter As String, _
   ByVal locus As String _
) As Long

Parameters

list
The Named List in which to store any Items found.
 
pos
The position in the overlays list of the overlay to be scanned.
 
filter
Optionally specifies a named Filter which Items must pass to be included in the scan. The Filter specified, if any, will be used in addition to any overlay drawing Filter.
 
locus
Optionally specifies a named Spatial Filter which Items must pass to be included in the scan. The Spatial Filter specified, if any, will be used in addition to any overlay drawing Spatial Filter.

Return Type

The number of Items found, i.e. the number of Items placed in the Named List.

Remarks

Available: GEO D OD OM OV SISpy

Groups:

Example

NFound = sis.ScanOverlay ("OverlayList", 0, "BandB", "")

All the items on the overlay in position 0 in the current window that pass the filter BandB will be placed in the list OverlayList.