3. Script Language > Variable Definitions and Operations > Array -Commands

ARR.Get Array

Previous Top Next

MiniRobotLanguage (MRL)

ARR.Get Array

Retrieves the value of a specific element in a specified array as String

clip0703

Intention

The ARR.Get Array command is designed to retrieve the value of a specific element in a specified array.

This is useful for accessing stored data within an array.

Element Retrieval: The command retrieves the value of the element at the specified index (P2) in the specified array (P1).

Data Types: The value retrieved can be a string or a binary string.

Result Placement: If P3 is omitted, the value of the element is placed on the TOS.

Auto Stop: If you specify an Index that has not been set with an Element, the result will be "" (empty)

Syntax

ARR.Get Array|P1|P2[|P3]

ARR.Get|P1|P2[|P3]

Parameter Explanation

•P1 - Array Number: Specifies the array number, which can range from 0 to 32. This is somehow the "Name" of the Array, yet it can be used as an second Index.

•P2 - Array Index: Specifies the index of the element within the array that you want to retrieve.

•P3 - Output Variable (Optional): Specifies the variable that will receive the value of the element at the given index. If omitted, the result is placed on the Top Of Stack (TOS).

Speed in Ticks:

clip0781

Example

'******************************************

' ARR.Get Array. - Sample

'******************************************

ARR.Get Array|5|10|$$RES

' Retrieves the 10th element of Array "5" and stores it in $$RES

END.

Remarks

Limitations: