.. highlightlang:: us

.. index:: SetClipboardText

.. _setclipboardtext:

SetClipboardText
================

.. us.tag  SetClipboardText ENGLISH FILE_MISC clipboard New320

:ref:`SetClipboardText` writes text into the clipboard.

.. function::  bool = SetClipboardText(ssText)

.. us.return

**Return Value**

*bool* is TRUE (1) if the text was written successfully otherwise the function
returns FALSE (0).

.. us.params

**Parameters**

.. uparam:: ssText

   *ssText* is the text to be copied to the clipboard.

.. us.example

**Example**

::

   smText = ["Engine", "123.123"; "Gearbox", "p12"];
   ssText = smprintf("%s", smText, "\t", "\n");
   SetClipboardText(ssText);

.. seealso::
   :ref:`overview-files`,
   :ref:`overview-clipboard`,
   :ref:`GetClipboardText`,
   :ref:`GetClipboardObject`,
   :ref:`EmptyClipboard`

:sub:`id-1493865`