UtilArrayToVariantArray Method

Convert an array of .NET built-in types to an equivalent Variant arrray (array of .NET Objects)

Definition

Namespace: ASCOM.Utilities
Assembly: ASCOM.Utilities (in ASCOM.Utilities.dll) Version: 7.1.3+4851.c5da65c2b

C#

public Object ArrayToVariantArray(
	Object SuppliedObject
)

VB

Public Function ArrayToVariantArray ( 
	SuppliedObject As Object
) As Object

C++

public:
virtual Object^ ArrayToVariantArray(
	Object^ SuppliedObject
) sealed

Parameters

SuppliedObject Object: The array to convert to variant types

Return Value

Object
A Variant array

Remarks

This function will primarily be of use to Scripting Language programmers who need to convert Camera and Video ImageArrays from their native types to Variant types. If this is not done, the scripting language will throw a type mismatch exception when it receives, for example, Int32 element types instead of the expected Variant types.

A VBScript Camera usage example is: Image = UTIL.ArrayToVariantArray(CAMERA.ImageArray) This example assumes that the camera and utilities objects have already been created with CreateObject statements.

The supported .NET types are:

Int16
Int32
UInt16
UInt32
UInt64
Byte
SByte
Single
Double
Boolean
DateTime
String

The function supports arrays with 1 to 5 dimensions (Rank = 1 to 5). If the supplied array already contains elements of Variant type, it is returned as-is without any processing.

Exceptions

InvalidValueException	If the supplied array contains elements of an unsuported Type.
InvalidValueException	If the array rank is outside the range 1 to 5.
InvalidValueException	If the supplied object is not an array.