<-- Previous || Up || Next -->

Copy Variant Matrix Direct Function
Array Manipulations Class

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

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

Summary:
          rTo                    vFm
    +----+----+----+       +----+----+----+
    | 12 | 34 | WV | <---- | 12 | 34 | WV |
    +----+----+----+   OR  +----+----+----+
    | 21 | 43 | CA |   +-- | 21 | 43 | CA | <-+
    +----+----+----+   |   +----+----+----+   |
                       |                      |
                       +----------------------+
Example:
    Assuming
       Static avarIn(0 To 45, 0 To 12) As Variant
       avarIn(1, 1) = "Smith"
       Dim avarOut() As Variant
    for example
       CopyVariantMatrixDirect(avarOut(), avarIn()) = True
See also:
    CopyVariantMatrix Function (indirect-copy version)
    CopyVariantArrayDirect Function (more flexible version)
    CopyVariantVectorDirect Function (for one-dimensional arrays)
    CopyVariantCubeDirect Function (for three-dimensional arrays)
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 two-dimensional and have the same upper and lower bounds as vFm.
vFm: The two-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.
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.
Return value: Function currently returns True in all cases.
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.

Return to ENTISOFT Home Page

Copyright 1999-2005 Entisoft