AIX - Artificial Intelligence and X Platform Utility

<< Click to Display Table of Contents >>

Navigation:  3. Script Language > AI - Artificial Intelligence Commands > AIX. - Grok / X - API > !Core Operations >

AIX - Artificial Intelligence and X Platform Utility

AIX.Set ClipboardOutput

Previous Top Next


MiniRobotLanguage (MRL)

 

AIX.Set ClipboardOutput
Set Whether Output is Copied to the Clipboard

 

Intention

 

Set ClipboardOutput Command: Configure Clipboard Behavior
 
The Set ClipboardOutput command configures whether the content of AI responses is copied to the clipboard, updating the AIX_ClipboardOutput global variable.

This controls output delivery in conjunction with AIX.Ask and AIX.AskVision.

It’s part of the AIX - Grok / X - API suite.

 

What is the Set ClipboardOutput Command?

 

The Set ClipboardOutput command sets the AIX_ClipboardOutput global variable to 1 (enabled) or 0 (disabled), determining if response content is copied to the clipboard.

This setting is used by HTP_AnalyzeGrokResponse, with copying limited by a 1MB size constraint.

 

Why Do You Need It?

 

Setting the clipboard output is beneficial for:

Control: Enables or disables clipboard copying as needed.

Efficiency: Prevents unwanted clipboard overwrites.

Integration: Supports workflows requiring clipboard access.

 

How to Use the Set ClipboardOutput Command?

 

Use the command to set the clipboard output behavior before executing AI queries with AIX.Ask or AIX.AskVision.

Set it to 1 to enable or 0 to disable, and verify with AIX.Get ClipboardOutput.

 

Example Usage

 

AIX.Set ClipboardOutput|1

AIX.Ask|""What is the capital of France?""

AIX.Get ClipboardOutput|$$SETTING

DBP.Clipboard output is $$SETTING (1=enabled, 0=disabled)

AIX.Set ClipboardOutput|0

AIX.Ask|""What is the next capital?""

 

This example enables clipboard output for the first query, verifies it, disables it for the second, and sends another query.

 

Illustration

 

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

│ Set Clipboard      │

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

│ Input: 0/1         │

│ Process: Update    │

│ Output: Setting    │

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

A visual of setting and updating the clipboard output configuration.

 

Syntax

 

AIX.Set ClipboardOutput|value

AIX_Set_ClipboardOutput|value

 

Parameter Explanation

 

value - (Required) A value of type LONG (0 or 1) where 0 disables clipboard copying and 1 enables it.

 

Remarks

 

- The setting is applied to the AIX_ClipboardOutput global variable and used by HTP_AnalyzeGrokResponse during response processing.

- Copying occurs only if the content size is within the %MAX_CLIPBOARD_SIZE limit (1MB).

 

Limitations

 

- Setting changes apply only to subsequent responses; it does not retroactively affect past outputs.

- Large responses exceeding 1MB are not copied, regardless of the setting.

 

See also:

 

AIX.Get ClipboardOutput

AIX.Ask

AIX.AskVision

Output Formatting and Delivery