|
<< Click to Display Table of Contents >> Navigation: 3. Script Language > Arrays and Data-Structures > ARS. - Array's > !ARS. - Text Document Operations > ARS. - Text Document Operations |
MiniRobotLanguage (MRL)
ARS.TextGet
Get the container's contents as a text document, appending a CrLf to each item.
Intention
The ARS.TextGet command retrieves the contents of the container as a text document, with each item separated by a carriage return and line feed (CrLf). This is useful for converting the container's contents into a readable text format.
Illustration:
Container Contents:
┌───────────────┐
│ Item 1 │
├───────────────┤
│ Item 2 │
├───────────────┤
│ Item 3 │
└───────────────┘
The container is converted to a text document with CrLf separators.
Syntax
ARS.TextGet|$$ARR[|$$STR]
Parameter Explanation
P1 - $$ARR The handle of the Deque.
P2 - $$STR (optional) The variable to store the resulting text document. If omitted, the result is placed on the Top of Stack (TOS).
Example
'***********************************
' ARS.TextGet - Sample Script
'***********************************
' Create a new Deque
ARS.New|$$DEQ
' Add items to the Deque
ARS.PushLast|$$DEQ|Item1
ARS.PushLast|$$DEQ|Item2
ARS.PushLast|$$DEQ|Item3
' Get the container as a text document
ARS.TextGet|$$DEQ|$$RES
DBP.The text document is: $$RES
' End the script
ENR.
Remarks
-
Limitations:
- The container must not be empty when using this command.
See also:
• ARS.New