|
<< 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 |
MiniRobotLanguage (MRL)
AIX.Get ClipboardOutput
Retrieve the Current Clipboard Output Setting
Intention
Get ClipboardOutput Command: Check Clipboard Behavior
The Get ClipboardOutput command retrieves the current setting that determines whether AI response content is copied to the clipboard, as managed by the AIX_ClipboardOutput global variable.
This allows users to verify the output delivery configuration.
It’s part of the AIX - Grok / X - API suite.
The Get ClipboardOutput command returns the value of the AIX_ClipboardOutput global variable, which indicates whether responses are copied to the clipboard (1 for enabled, 0 for disabled).
This setting is used by the HTP_AnalyzeGrokResponse subroutine to control clipboard behavior.
Retrieving the clipboard output setting is useful for:
•Configuration Check: Verifies the current clipboard output state.
•Workflow Adjustment: Adapts scripts based on clipboard usage.
•Debugging: Ensures the setting aligns with intended behavior.
Use the command to retrieve the current clipboard output setting at any time, especially after setting it with AIX.Set ClipboardOutput.
Store the result in a variable to use in conditional logic or display it.
Example Usage
AIX.Set ClipboardOutput|1
AIX.Get ClipboardOutput|$$SETTING
IF $$SETTING = 1 THEN
DBP.Clipboard output is enabled
ELSE
DBP.Clipboard output is disabled
END IF
This example enables clipboard output, retrieves the setting, and displays its status.
Illustration
┌────────────────────┐
│ Clipboard Setting │
├────────────────────┤
│ Input: Global Var │
│ Process: Retrieve │
│ Output: 0/1 │
└────────────────────┘
A visual of retrieving the clipboard output setting (0 for disabled, 1 for enabled).
Syntax
AIX.Get ClipboardOutput|$$variable
AIX_Get_ClipboardOutput|$$variable
Parameter Explanation
$$variable - (Required) A variable (e.g., $$SETTING) of type LONG where the clipboard output setting (0 or 1) will be stored.
Remarks
- The setting is stored in the AIX_ClipboardOutput global variable, which defaults to 0 unless changed by AIX.Set ClipboardOutput.
- This setting influences clipboard copying in AIX.Ask and AIX.AskVision, subject to the %MAX_CLIPBOARD_SIZE limit (1MB).
Limitations
- Reflects only the current global setting; does not dynamically check clipboard success.
- No direct indication of whether the last copy operation succeeded due to size limits.
See also:
• AIX.Ask
• Output Formatting and Delivery