GetArray - Learn To Code - PlayBASIC Documentation

GetArray

ArrayIndex = GetArray(Array())

Parameters:

Array() = The Array you wish to get the index of

Returns:

ArrayIndex = The handle/index of this array

The GetArray functions returns the ArrayIndex value of the requested array. These value can then be used with SetArray to point redirection arrays at the requested arrays data.

See MakeArray for more information on redirection arrays

FACTS:

* GetArray should only be used with normal Arrays created with Dim command.

Mini Tutorial :

This example shows how GetArray can be used to get an array handle which is used to point and point a redirection array at it's data.

; Dimension an integer array called Table()
  Dim Table(10)

; Declare a Redirection Array called RedirectArray()
  MakeArray RedirectArray()

; Set RedirectArray() to point at the Table()'s data
  SetArray RedirectArray(),GetArray(table())

; Fill RedirectArray() with values
  For lp =0 To GetArrayElements(RedirectArray(),1)
     RedirectArray(lp) = 100+lp
  Next


; Display The Values in RedirectArray() and Table()
; Of course they will match, since they are in effect
; one and the same. Since RedirectArray() is currently
; indirectly pointing at Table()'s data.

  For lp=0 To 10
     s$="Table():"+Str$(Table(LP))+" - RedirectArray():"
     s$=s$+Str$(RedirectArray(LP))
     Print s$
  Next

; Display screen and wait for a key press
  Sync
  WaitKey

This example would output the following.

  Table():100 - RedirectArray(): 100
  Table():101 - RedirectArray(): 101
  Table():102 - RedirectArray(): 102
  Table():103 - RedirectArray(): 103
  Table():104 - RedirectArray(): 104
  Table():105 - RedirectArray(): 105
  Table():106 - RedirectArray(): 106
  Table():107 - RedirectArray(): 107
  Table():108 - RedirectArray(): 108
  Table():109 - RedirectArray(): 109
  Table():110 - RedirectArray(): 110


Related Info:	DeleteArray \| Dim \| MakeArray \| MoveArray \| ReDim \| SetArray \| SwapArray \| UnDim :