Description of MUSHclient world function: world.ArrayGetFirstKey
Name | ArrayGetFirstKey |
---|---|
Type | Method |
Summary | Gets the key of the first element in the array (if any) |
Prototype | VARIANT ArrayGetFirstKey(BSTR Name);
|
Description | This retrieves the key of the first element in a specified array. You can then use ArrayGet to get the value associated with that key. Note: Available in version 3.46 onwards. |
VBscript example |
|
Lua example |
|
Lua notes |
|
Returns | The value of the first key for the specified array. |
Introduced in version | 3.46 |
See also ...
Function | Description |
---|---|
ArrayClear | Clears an array |
ArrayCreate | Creates an array |
ArrayDeleteKey | Deletes a key/value pair from an array |
ArrayGet | Gets the value of an array item |
ArrayGetLastKey | Gets the key of the last element in the array (if any) |
ArrayKeyExists | Tests to see if the specified array key exists |
ArrayListKeys | Gets the list of all the keys in an array |
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.