Register forum user name Search FAQ

ArrayDelete

Script function

world.ArrayDelete

Read about scripting

Type

Method

Summary

Deletes an array

Prototype

long ArrayDelete(BSTR Name);

View list of data type meanings

Description

This deletes a previously-created arrays. All values are discarded. Arrays are automatically deleted when the world is closed, or the plugin closed if the array is in a plugin.


Available in MUSHclient version 3.46 onwards.



VBscript example

ArrayDelete "spells"


Lua example

ArrayDelete "spells"


Return value

eBadArrayName: Name cannot be empty
eArrayDoesNotExist: Array does not exist
eOK: Deleted OK

View list of return code meanings

See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(ArrayClear) Clears an array
(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDeleteKey) Deletes a key/value pair from an array
(ArrayExists) Tests to see if the specified array exists
(ArrayExport) Exports values from an array into a single string
(ArrayExportKeys) Exports keys from an array into a single string
(ArrayGet) Gets the value of an array item
(ArrayGetFirstKey) Gets the key of the first element in the array (if any)
(ArrayGetLastKey) Gets the key of the last element in the array (if any)
(ArrayImport) Imports values into an array from a single string
(ArrayKeyExists) Tests to see if the specified array key exists
(ArrayListAll) Gets the list of arrays
(ArrayListKeys) Gets the list of all the keys in an array
(ArrayListValues) Gets the list of all the values in an array
(ArraySet) Sets the value of an array item
(ArraySize) Returns the number of elements in a specified array

(Help topic: function=ArrayDelete)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.