CLIPTOSTR() Function - Get Clipboard Data in Specified Format
Syntax
CLIPTOSTR (fmt[,ERR=lineref])
Description
For BBj-specific information, see the Clipboard
Verbs and Functions.
The CLIPTOSTR() function returns a string in an fmt-parameter-specified
clipboard format that can be processed by the application. If fmt
is 1, the returned string is probably ASCII text. Any other specified
format must be matched against the application's ability to process it.
For formats 1 (text) and 7 (OEM text), the null terminator is removed
before the string is returned. If the requested format is unavailable,
an !ERROR=92 is generated.
In this case, the error code returned by windows and placed in TCB(10)
is unreliable; Visual PRO/5 often sets TCB(10) to 93 to indicate that
although windows did not return an error code, the operation failed.
|
Parameter |
Description |
|---|---|
|
fmt |
An unsigned 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 CLIPTOSTR() 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. |