<< Click to Display Table of Contents >> Navigation:  3. Script Language > AI - Artificial Intelligence Commands > AIU. - OpenAI API > !Output Formatting and Delivery > AIU. - Artificial Intelligence Utility

---

MiniRobotLanguage (MRL)

 

AIU.GetClipboardOutput
Retrieve Current Clipboard Output Setting

 

Intention

 

GetClipboardOutput Command: Checking Clipboard Output Status
 
The GetClipboardOutput command retrieves the current setting that determines whether AIU operation outputs are copied to the clipboard.

This is useful for debugging or verifying the clipboard behavior in your scripts.

It’s part of the AIU - OpenAI API suite.

 

What is the GetClipboardOutput Command?

 

This command returns the current clipboard output setting as a numeric value: 0 (disabled) or 1 (enabled).

You can store the result in a variable or, if no variable is specified, it will be placed on the Top of Stack (TOS).

 

Why Do You Need It?

 

Retrieving the clipboard output setting is valuable for:

•Verification: Confirm whether clipboard output is enabled before running operations.

•Debugging: Troubleshoot unexpected clipboard behavior in your scripts.

•Dynamic Control: Adjust script logic based on the current setting.

 

How to Use the GetClipboardOutput Command?

 

Call this command with an optional variable to store the result. If omitted, the value is pushed to the stack.

The default setting is 0 (disabled) unless modified by AIU.SetClipboardOutput.

 

Example Usage

 

AIU.SetClipboardOutput|1

AIU.GetClipboardOutput|$$CLP

DBP.Clipboard Output Enabled: $$CLP

AIU.GetClipboardOutput

POP.$$STA

DBP.Stack Retrieved Setting: $$STA

 

The result will be 1 if enabled, 0 if disabled.

 

Illustration

 

┌────────────────────┐

│ Clipboard Status   │

├────────────────────┤

│ Enabled (1)        │

└────────────────────┘

Checking the clipboard output status.

 

Syntax

 

AIU.GetClipboardOutput[|P1]

AIU.Get_ClipboardOutput[|P1]

 

Parameter Explanation

 

P1 - (Optional) The variable where the clipboard setting (0 or 1) will be stored. If omitted, the value is placed on the Top of Stack (TOS).

 

Example

 

AIU.SetClipboardOutput|0

AIU.GetClipboardOutput|$$SET

DBP.Clipboard Output Disabled: $$SET

ENR.

 

Remarks

 

- The default value is 0 unless changed by AIU.SetClipboardOutput.

- Returns a numeric value for easy use in conditional logic.

 

Limitations

 

- Accepts at most one parameter; additional parameters cause an error.

- Only reflects the current setting, not whether the clipboard is functional.

 

See also:

 

• AIU.Set_ClipboardOutput

• AIU.Chat

• AIU.GenerateURL

• Clipboard Configuration