Cadcorp SIS API Methods

CompactDataset Method

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

Description

Discards all undo actions and defragments the memory used by a dataset.

Syntax

Visual Basic
Public Function CompactDataset( _
   ByVal nDataset As Long _
) As Integer

Parameters

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

Remarks

The current open Item, if any, will be closed and the current selection list will be emptied before compacting the dataset.

Available: GEO MD MM ME OD OM OV SISpy

Group:

Example

sis.CompactDataset(GetInt(SIS_OT_OVERLAY, 0, "_nDataset&"))


Send comments on this topic.

Click to return to www.cadcorp.com

© Copyright 2000-2017 Computer Aided Development Corporation Limited (Cadcorp).