Function Array Manipulations Class

CopyVariantCubeDirect

Copy a three-dimensional Variant array to another Variant array.

Signature (Visual Basic / VBA)

Public Function CopyVariantCubeDirect( _
      ByRef rTo() As Variant _
    , ByRef vFm() As Variant _
    ) As Boolean

Code Example

    Assuming
       Static avarIn(0 To 45, 0 To 12, 0 To 3) As Variant
       avarIn(1, 1, 1) = "Smith"
       Dim avarOut() As Variant
    for example
       CopyVariantCubeDirect(avarOut(), avarIn()) = True

Parameters

Parameter Description
rTo Destination array that will receive a copy of array vFm. This function will attempt to re-dimension rTo so that it has the same dimensions as vFm. It will ignore errors during that re-dimension so that rTo can be a Static array. If rTo is Static, it must be three-dimensional and have the same upper and lower bounds as vFm.
vFm The three-dimensional array of Variants that will be copied to rTo. vFm can be either Static or dynamic. If vFm is dynamic, it must be dimensioned before being passed to this function.

Return Value

Function currently returns True in all cases.

Notes & Version History

Warning Function assumes that rTo and vFm are different arrays. If they are not, and if vFm/rTo is dynamic, then the contents of vFm will be lost.
v1.2 Change Changed to allow rTo to be Static by making the function ignore errors that occur while re-dimensioning the destination array rTo.