ClipWait

Waits until the clipboard contains data.

ClipWait Timeout, WaitForAnyData

Parameters

Timeout

Type: Integer

If omitted, the function will wait indefinitely. Otherwise, it will wait no longer than this many seconds (can contain a decimal point).

WaitForAnyData

Type: Integer (boolean)

If this parameter is omitted or 0 (false), the function is more selective, waiting specifically for text or files to appear ("text" includes anything that would produce text when you paste into Notepad). If this parameter is 1 (true), the function waits for data of any kind to appear on the clipboard.

Return Value

Type: Integer (boolean)

This function returns 0 (false) if the function timed out or 1 (true) otherwise (i.e. the clipboard contains data).

Remarks

It's better to use this function than a loop of your own that checks to see if this clipboard is blank. This is because the clipboard is never opened by this function, and thus it performs better and avoids any chance of interfering with another application that may be using the clipboard.

This function considers anything convertible to text (e.g. HTML) to be text. It also considers files, such as those copied in an Explorer window via Control+C, to be text. Such files are automatically converted to their filenames (with full path) whenever the clipboard variable is referred to in the script. See A_Clipboard for details.

When 1 (true) is present as the last parameter, the function will be satisfied when any data appears on the clipboard. This can be used in conjunction with ClipboardAll to save non-textual items such as pictures.

While the function is in a waiting state, new threads can be launched via hotkey, custom menu item, or timer.

To wait for a fraction of a second, specify a floating point value for the first parameter, for example, 0.25 to wait for a maximum of 250 milliseconds.

Related

A_Clipboard, WinWait, KeyWait

Examples

#1

clipboard := "" ; Empty the clipboard
Send "^c"
if !ClipWait(2)
{
    MsgBox "The attempt to copy text onto the clipboard failed."
    return
}
MsgBox "clipboard = " clipboard
return