CLIPISFORMAT() Function - Get Clipboard Format Availability

Syntax

CLIPISFORMAT (fmt[,ERR=lineref])

Description

For BBj-specific information, see the Clipboard Verbs and Functions.

The CLIPISFORMAT() function checks the availability of clipboard formats for data to be copied to the application. A non-zero value indicates that the format is available and can be retrieved by the application. Clipboard formats between 1 and 1023 are reserved by Windows. Clipboard format 1 is the identifying format for plain text. Clipboard format 8 is the identifying format for bitmaps and should be copied or pasted to a file with CLIPFROMFILE and CLIPTOFILE.

Parameter

Description

fmt

A positive integer that represents a clipboard format registered by CLIPREGFORMAT().

ERR=lineref

Branch to be taken if an error occurs during execution.

Remarks

TIM=int In BBj 20.20 and higher, the TIM=int option will cause the CLIPISFORMAT() function to timeout, reporting an error, if it's not able to read the clipboard within int seconds. TIM=0 is equivalent to not specifying the TIM=int option at all.

See Also

CLIPCLEAR

CLIPFROMFILE

CLIPFROMSTR

CLIPLOCK

CLIPREGFORMAT

CLIPTOFILE

CLIPTOSTR

CLIPUNLOCK

Functions - Alphabetical Listing