SalSafeArray

PPJ.Runtime.Com.SalSafeArray

Namespace: PPJ.Runtime.Com

Assembly: PPJ.Runtime.49 (4.9.0.0)

SalSafeArray implementation.

C#

public class SalSafeArray : SalFunctionalClass

VB.NET

Public Class SalSafeArray
    Inherits SalFunctionalClass

Constructors

SalSafeArray()

Constructs a new empty SalSafeArray This class cannot be used as second-base class.

SalSafeArray(array)

Constructs a new SalSafeArray with the wrapped array.

Name	Type	Description
array	Array

Properties

Value

Array: Returns/Sets the wrapped object.

Methods

Create(vt, elements, lowerBound)

Creates a new SafeArray.

Parameter	Type	Description
vt	SalNumber
elements	SalNumber
lowerBound	SalNumber

Returns: SalBoolean.

Create2D(vt, elements1, elements2, lowerBound1, lowerBound2)

Creates a new safearray.

Parameter	Type	Description
vt	SalNumber
elements1	SalNumber
elements2	SalNumber
lowerBound1	SalNumber
lowerBound2	SalNumber

Returns: SalBoolean.

CreateMD(vt, elements, lowerBounds)

Creates a new multidimensional safearray.

Parameter	Type	Description
vt	SalNumber
elements	SalArray<SalNumber>
lowerBounds	SalArray<SalNumber>

Returns: SalBoolean.

GetBoolean(boolean, index)

Parameter	Type	Description
boolean	SalBoolean&
index	SalNumber

Returns: SalBoolean.

GetBoolean2D(boolean, index1, index2)

Parameter	Type	Description
boolean	SalBoolean&
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetBooleanMD(boolean, indices)

Parameter	Type	Description
boolean	SalBoolean&
indices	SalArray<SalNumber>

Returns: SalBoolean.

GetDate(date, index)

Parameter	Type	Description
date	SalDateTime&
index	SalNumber

Returns: SalBoolean.

GetDate2D(date, index1, index2)

Parameter	Type	Description
date	SalDateTime&
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetDateMD(date, indices)

Parameter	Type	Description
date	SalDateTime&
indices	SalArray<SalNumber>

Returns: SalBoolean.

GetLowerBound()

Returns the lower bound.

Returns: SalNumber.

GetLowerBound2D(nDim)

Parameter	Type	Description
nDim	SalNumber

Returns: SalNumber.

GetLowerBoundMD(nDim)

Parameter	Type	Description
nDim	SalNumber

Returns: SalNumber.

GetNumber(num, index)

Parameter	Type	Description
num	SalNumber&
index	SalNumber

Returns: SalBoolean.

GetNumber2D(num, index1, index2)

Parameter	Type	Description
num	SalNumber&
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetNumberMD(num, indices)

Parameter	Type	Description
num	SalNumber&
indices	SalArray<SalNumber>

Returns: SalBoolean.

GetObject(obj, index)

Returns a COM object item from the safearray.

Parameter	Type	Description
obj	SalObject
index	SalNumber

Returns: SalBoolean.

GetObject2D(obj, index1, index2)

Parameter	Type	Description
obj	SalObject
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetObjectMD(obj, indices)

Parameter	Type	Description
obj	SalObject
indices	SalArray<SalNumber>

Returns: SalBoolean.

GetString(str, index)

Parameter	Type	Description
str	SalString&
index	SalNumber

Returns: SalBoolean.

GetString2D(str, index1, index2)

Parameter	Type	Description
str	SalString&
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetStringMD(str, indices)

Parameter	Type	Description
str	SalString&
indices	SalArray<SalNumber>

Returns: SalBoolean.

GetUpperBound()

Returns the upper bound.

Returns: SalNumber.

GetUpperBound2D(nDim)

Parameter	Type	Description
nDim	SalNumber

Returns: SalNumber.

GetUpperBoundMD(nDim)

Parameter	Type	Description
nDim	SalNumber

Returns: SalNumber.

GetVariant(variant, index)

Parameter	Type	Description
variant	SalVariant&
index	SalNumber

Returns: SalBoolean.

GetVariant2D(variant, index1, index2)

Parameter	Type	Description
variant	SalVariant&
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

GetVariantMD(variant, indices)

Parameter	Type	Description
variant	SalVariant&
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutBoolean(boolean, index)

Stores a boolean item in the safearray.

Parameter	Type	Description
boolean	SalBoolean
index	SalNumber

Returns: SalBoolean.

PutBoolean2D(boolean, index1, index2)

Parameter	Type	Description
boolean	SalBoolean
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutBooleanMD(boolean, indices)

Multidimensional safe array

Parameter	Type	Description
boolean	SalBoolean
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutDate(date, index)

Stores a DateTime item in the safearray.

Parameter	Type	Description
date	SalDateTime
index	SalNumber

Returns: SalBoolean.

PutDate2D(date, index1, index2)

Parameter	Type	Description
date	SalDateTime
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutDateMD(date, indices)

Multidimensional safe array

Parameter	Type	Description
date	SalDateTime
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutNumber(num, index)

Stores a numeric item in the safearray.

Parameter	Type	Description
num	SalNumber
index	SalNumber

Returns: SalBoolean.

PutNumber2D(num, index1, index2)

Parameter	Type	Description
num	SalNumber
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutNumberMD(num, indices)

Multidimensional safe array

Parameter	Type	Description
num	SalNumber
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutObject(obj, index)

Stores a com object item in the safearray.

Parameter	Type	Description
obj	SalObject
index	SalNumber

Returns: SalBoolean.

PutObject2D(obj, index1, index2)

Parameter	Type	Description
obj	SalObject
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutObjectMD(obj, indices)

Multidimensional safe array

Parameter	Type	Description
obj	SalObject
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutString(str, index)

Stores a string item in the safearray.

Parameter	Type	Description
str	SalString
index	SalNumber

Returns: SalBoolean.

PutString2D(str, index1, index2)

Parameter	Type	Description
str	SalString
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutStringMD(str, indices)

Multidimensional safe array

Parameter	Type	Description
str	SalString
indices	SalArray<SalNumber>

Returns: SalBoolean.

PutVariant(variant, index)

Stores a variant object item in the safearray.

Parameter	Type	Description
variant	SalVariant
index	SalNumber

Returns: SalBoolean.

PutVariant2D(variant, index1, index2)

Parameter	Type	Description
variant	SalVariant
index1	SalNumber
index2	SalNumber

Returns: SalBoolean.

PutVariantMD(variant, indices)

Multidimensional safe array

Parameter	Type	Description
variant	SalVariant
indices	SalArray<SalNumber>

Returns: SalBoolean.