# Function Reference

# ClipPut

Writes text to the clipboard.

ClipPut ( "value" )

## Parameters

value | The text to write to the clipboard.

## Return Value

Success: | 1.
Failure: | 0.

## Remarks

Any existing clipboard contents are overwritten.
An empty string "" will empty the clipboard.

## Related

ClipGet

## Example

    #include <MsgBoxConstants.au3>

    Example()

    Func Example()
        ; Retrieve the data stored in the clipboard.
        Local $sData = ClipGet()

        ; Display the data returned by ClipGet.
        MsgBox($MB_SYSTEMMODAL, "", "The following data is stored in the clipboard: " & @CRLF & $sData)

        ; Add new data to the clipboard.
        ClipPut("A new string added to the clipboard.")

        ; Retrieve the data stored in the clipboard.
        $sData = ClipGet()

        ; Display the data returned by ClipGet.
        MsgBox($MB_SYSTEMMODAL, "", "The following data is now stored in the clipboard: " & @CRLF & $sData)
    EndFunc   ;==>Example