Description of MUSHclient world function: world.ArrayDeleteKey
Name | ArrayDeleteKey |
---|---|
Type | Method |
Summary | Deletes a key/value pair from an array |
Prototype | long ArrayDeleteKey(BSTR Name, BSTR Key);
|
Description | This deletes a key/value pair from an array. You specify which key to delete, and if it exists in the array, it is deleted. Note: Available in version 3.46 onwards. |
VBscript example |
|
Lua example |
|
Returns | eBadArrayName: Name cannot be empty
|
Introduced in version | 3.46 |
See also ...
Function | Description |
---|---|
ArrayClear | Clears an array |
ArrayCreate | Creates an array |
ArrayDelete | Deletes an array |
ArrayGet | Gets the value of an array item |
ArraySet | Sets the value of an array item |
Enter a word or phrase in the box below to narrow the list down to those that match.
The function name, prototype, summary, and description are searched.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
You can view a list of the data types used in function prototypes
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.