hiClearClipboard

hiClearClipboard(
[ s_mode ]
) 
=> t / nil

Description

Clears the text stored in the system clipboard.

Argument

s_mode

The clipboard buffer to inspect. Possible values are: 'selection: the UNIX middle-mouse-paste selection. 'clipboard: copy buffer, typically used when performing the Copy operation in a GUI. Default value is 'selection.

Values Returned

t	The clipboard is cleared.
nil	An invalid argument is specified.

Examples

hiGetClipboard()
=> ""   

hiSetClipboard( "text to copy" )
=> t

hiGetClipboard()
=> "text to copy"

hiGetClipboard( 'clipboard )
=> ""  ; defaults to 'selection, so 'clipboard is not set

hiSetClipboard( "some stuff for the clipboard" 'clipboard)
=> t

hiGetClipboard()
=> "text to copy"

hiGetClipboard( 'clipboard )
=> "some stuff for the clipboard"

hiGetClipboard( 'selection )
=> "text to copy"

hiClearClipboard()
=> t

hiGetClipboard()
=> ""

Related Topics

Functions of Viewfile Window

Return to top