Dialogs, Clipboard, Platform, and Path Functions

These functions interact with the host environment.

Reads text from the system clipboard.

Returns: string.

Example:

text = from_clipboard();

Shows an OK message dialog.

Returns: numeric dialog result code.

Example:

msg_ok('Operation complete');

Shows an OK/Cancel message dialog.

Returns: numeric dialog result code.

Example:

result = msg_ok_cancel('Continue?');

Shows a Yes/No message dialog.

Returns: numeric dialog result code.

Example:

result = msg_yes_no('Use current position?');

Shows a Yes/No/Cancel message dialog.

Returns: numeric dialog result code.

Example:

result = msg_yes_no_cancel('Save changes?');

Returns the current profile path.

Returns: string.

Example:

profilePath = path();

Resolves a path through the host profile path rules.

Returns: string.

Example:

filePath = path('scripts/probe.expr');

Returns a string identifying the platform.

Returns: string: `windows`, `linux`, `apple`, `arm`, or `unknown`.

Example:

if(platform() == 'windows')
{
    print('Running on Windows');
};

Writes text to the system clipboard.

Returns: boolean-style result from the host clipboard operation.

Example:

to_clipboard('Copied text');

Previous: Output, Formatting, and Errors

Next: Methods and properties