All Cadcorp SIS API Methods

GetDatasetContainer Method

Description

Gets the serial number of the dataset which contains the specified dataset (e.g. in an Index Dataset).

Syntax

Visual Basic 
Public Function GetDatasetContainer( _
   ByVal nDataset As Long, _
   ByVal nContainer As Integer _
) As Long

Parameters

nDataset
The serial number of the dataset whose container is required. The serial number can be obtained from the Dataset property of an overlay, or from the GetDataset or FindExternalDataset methods.
 
nContainer
The index of the container dataset in the datasets list of containers (e.g. if a tile is included in more than one Index Dataset, then nContainer% can have the value between 1 and the number of datasets).

Return Type

The serial number of the dataset container, or 0 if the dataset has no containers. If the nContainer% value is greater than the available number of containers, a non-existent serial number will be returned.

Remarks

The serial number cannot be relied upon to be identical in each session, or if the dataset is removed and re-added. The number returned should therefore not be stored for long-term use.

Available: GEO D OD OM SISpy

Example

sis.GetDatasetContainer (1, 1)