ArrayListAll
Script function

world.ArrayListAll

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of arrays

Prototype

VARIANT ArrayListAll();

DOC_data_types View list of data type meanings

Description

Returns an array of all the arrays currently defined.

VBscript example

dim arrList

arrList = world.ArrayListAll

If Not IsEmpty (arrList) Then
  
  For Each a In arrList 
    world.note a
  Next

End If


Lua example

for k, v in pairs (ArrayListAll ()) do 
  Note (v) 
end


Return value

If there are no arrays then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the arrays. 

Use "lbound" and "ubound" to find the bounds of the array of arrays (ie. the number of arrays in the list). You can then use "ArrayListKeys" to find the keys for each array.



See Also ...

Topics

DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_variables Variables

Functions

FNC_ArrayClear ArrayClear (Clears an array)
FNC_ArrayCount ArrayCount (Returns the number of arrays)
FNC_ArrayCreate ArrayCreate (Creates an array)
FNC_ArrayDelete ArrayDelete (Deletes an array)
FNC_ArrayDeleteKey ArrayDeleteKey (Deletes a key/value pair from an array)
FNC_ArrayExists ArrayExists (Tests to see if the specified array exists)
FNC_ArrayExport ArrayExport (Exports values from an array into a single string)
FNC_ArrayExportKeys ArrayExportKeys (Exports keys from an array into a single string)
FNC_ArrayGet ArrayGet (Gets the value of an array item)
FNC_ArrayGetFirstKey ArrayGetFirstKey (Gets the key of the first element in the array (if any))
FNC_ArrayGetLastKey ArrayGetLastKey (Gets the key of the last element in the array (if any))
FNC_ArrayImport ArrayImport (Imports values into an array from a single string)
FNC_ArrayKeyExists ArrayKeyExists (Tests to see if the specified array key exists)
FNC_ArrayListKeys ArrayListKeys (Gets the list of all the keys in an array)
FNC_ArrayListValues ArrayListValues (Gets the list of all the values in an array)
FNC_ArraySet ArraySet (Sets the value of an array item)
FNC_ArraySize ArraySize (Returns the number of elements in a specified array)

(Help topic: function=ArrayListAll)

DOC_contents Documentation contents page