All Cadcorp SIS API Methods

FindDatasetOverlay Method

Description

Finds an overlay which contains the given dataset.

Syntax

Public Function FindDatasetOverlay( _
   ByVal nDataset As Long, _
   ByVal pos As Integer, _
   ByVal bForwards As Integer _
) As Integer

Parameters

nDataset

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

 

pos

The position in the list of overlays from which to calculate the search start (see bForwards, below). If set to -1 then the entire list is searched in the order specified by bForwards.

 

bForwards

True	Search from pos% + 1 (or the start if pos% is -1) to the end of the list of overlays.
False	Search from pos% - 1 (or the end if pos% is -1) to the beginning of the list of overlays.

Return Type

The position in the list of overlays of an overlay which contains the dataset, or -1 if the dataset is not found.

Remarks

Example

sis.FindDatasetOverlay (4, –1, True)