All Cadcorp SIS API Methods

ScanDataset Method

Description

Scans a dataset for Items, storing any found in a Named List

Syntax

Public Function ScanDataset( _
   ByVal list As String, _
   ByVal nDataset As Long, _
   ByVal filter As String, _
   ByVal locus As String _
) As Long

Parameters

list

The Named List in which to store any Items found.

 

nDataset

The serial number of the dataset to be scanned. The number can be obtained from the Dataset property of an overlay or from the GetDataset, GetDatasetContainer or FindExternalDataset methods.

 

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.

Remarks

Available: GEO D OD OM OV SISpy

Group:

• Spatial Searching Methods

Example

NFound = sis.ScanDataset ("ItemsFound", 4, "Conservation", "Talbot")

Finds all the items in the dataset serial number 4 that pass the Conservation filter and fall within the Talbot Spatial Filter, and places them in the named list ItemsFound.