---
title: "getClipboardText"
canonical: "https://help.vicon.com/space/ShogunPost121/1253737064/getClipboardText"
format: markdown
---
# Description

Gets text that was copied to the clipboard.

## Functional area

System

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `getClipboardText` |

### Arguments

None

### Flags

None

## Return value

string

Any text that was copied onto the system clipboard.

## Examples

```plaintext
// Copy some text to the clipboard and then get it, verifying
// that they are the same
string $str;
copyString "Hello Shogun User";
$str = `getClipboardText`;
 
// Will print "Hello Shogun User"
print $str;
```

> Macro (scroll-pagebreak)

# Additional information

## Related commands

- [copyString](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737246)