View source for CATable::GetSafeArray

[[CATable|<< Back to CATable]]

= [[CATable]]::GetSafeArray( ) =

Retrieves the [[CATable]] as a safe array (i.e., a Visual Basic array, .NET array, etc). The ordering of the dimensions is controlled by the [[CATable::SetIndexOrder|SetIndexOrder]] method. The elements of each dimension are indexed 1 to N, where N is the size of each index.

When you are reading an array with 2 or more dimensions, you should call [[CATable::SetIndexOrder|SetIndexOrder]] first to ensure the order of dimensions in the result are in the order you would like.

= Return value =

Array

= Example Usage =

The table is set to the contents of the Visual Basic array.
<code>
:dim Var As CAObject
:Dim curTable
:curTable = Var.GetSafeArray
</code>

= See Also =

* [[CATable::GetDataByLabels]], [[CATable::GetDataByElements]]
* [[CATable::PutSafeArray]]
* [[CATable::SetIndexOrder]]