All Cadcorp SIS API Methods

Scan Method

Description

Scans all overlays of the current SWD for items, storing any found in a Named List.

The method enumerates Items contained in an SWD, testing each of them against the specified status, Filter and Spatial Filter.

Syntax

Public Function Scan( _
   ByVal list As String, _
   ByVal stat As String, _
   ByVal filter As String, _
   ByVal locus As String _
) As Long

Parameters

list

The Named List in which to store any Items found.

 

stat

The status of Items to be included in the scan.

"I"	All Items.
"V"	Visible, Hittable and Editable Items.
"H"	Hittable and Editable Items.
"E"	Editable Items only.

 

filter

Optionally specifies a named Filter which items must pass to be included in the scan.

 

locus

Optionally specifies a named Spatial Filter which items must pass to be included in the scan. Use an empty string to omit the Spatial Filter.

Return Type

Remarks

Available: GEO D OD OM OV SISpy

Groups:

• Item Methods
• Spatial Searching Methods
• Named List Methods

Example

NItems = sis.Scan ("ItemsFound", "H", "Conservation", "Talbot")

Finds all the items in hittable overlays that pass the filter Conservation within the Spatial Filter Talbot and place them in the named list ItemsFound.