Jump to content

Sys2PutClipboardText: Difference between revisions

From EDM2
No edit summary
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==Description==
Writes a string to the clipboard in plain-text format. Specifying either no value or an empty string in the first argument will simply clear the clipboard of CF_TEXT data.
Writes a string to the clipboard in plain-text format. Specifying either no value or an empty string in the first argument will simply clear the clipboard of CF_TEXT data.


This function requires Presentation Manager to be active, although the REXX program itself need not be running in a PM process.
This function requires Presentation Manager to be active, although the REXX program itself need not be running in a PM process.
Line 6: Line 5:
==Arguments==
==Arguments==
REXX ARGUMENTS:
REXX ARGUMENTS:
  1. String to be written to the clipboard  (DEFAULT: "")
1. String to be written to the clipboard  (DEFAULT: "")
  2. Flag indicating whether other clipboard formats should be cleared:
2. Flag indicating whether other clipboard formats should be cleared:
      Y = yes, call WinEmptyClipbrd() before writing text  (DEFAULT)
    Y = yes, call WinEmptyClipbrd() before writing text  (DEFAULT)
      N = no, leave (non-CF_TEXT) clipboard data untouched
    N = no, leave (non-CF_TEXT) clipboard data untouched


==Return Value==
==Return Value==
REXX RETURN VALUE:  1 on success, 0 on failure
REXX RETURN VALUE:  1 on success, 0 on failure


[[Category:The OS/2 API Project]]
[[Category:RxUtilEx]]

Revision as of 14:32, 26 February 2017

Writes a string to the clipboard in plain-text format. Specifying either no value or an empty string in the first argument will simply clear the clipboard of CF_TEXT data.

This function requires Presentation Manager to be active, although the REXX program itself need not be running in a PM process.

Arguments

REXX ARGUMENTS:

1. String to be written to the clipboard  (DEFAULT: "")
2. Flag indicating whether other clipboard formats should be cleared:
    Y = yes, call WinEmptyClipbrd() before writing text  (DEFAULT)
    N = no, leave (non-CF_TEXT) clipboard data untouched

Return Value

REXX RETURN VALUE: 1 on success, 0 on failure