SetArray - Learn To Code - PlayBASIC Documentation

SetArray

SetArray RedirectArray(), ArrayIndex

Parameters:

RedirectArray() = The Redirection Array you want to redirect
ArrayIndex = The handle/index of the array

Returns: NONE

SetArray sets a redirection array to indirectly point at a target arrays data.

See MakeArray for more information on redirection arrays.

FACTS:

      * SetArray should only be used with Redirection Arrays Stubs created by the MakeArray command.

      * SetArray can not accept just any old value for the ArrayIndex, rather it expects this value to be created from the GetArray() function.

Mini Tutorial :

      This example shows how SetArray can be used to redirect one array to act upon another arrays 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 \| GetArray \| MakeArray \| ReDim \| UnDim :