  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fifteen — Windows/OS Functions (continued)
Overview
The ClipboardOpen function opens the clipboard and creates a Clipboard Object.
Syntax/Parameters
Syntax
handle = ClipboardOpen ( );
Parameters
(none)
Return Value
Returns a handle to a Clipboard Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.
Remarks
ClipboardOpen will open the clipboard and create a Clipboard Object without altering its contents. While most functions will automatically open and close the clipboard as necessary, opening the clipboard and holding the handle is more efficient for multiple operations while safeguarding the state of the clipboard so it cannot be altered by another program.
Once the clipboard is open, all functions that allow a handle to be specified will use the open handle unless a different handle is specified. The handle can be specified for clarity but the function will operate in the same manner.
Since only one program, thread or script can have the clipboard open, if this function is called without closing an existing handle, it will return the same handle. If another script or program has the clipboard locked, an error will be returned.
Scripts should not hold the clipboard open any longer than necessary since no other application can access the clipboard until it is closed. Further, only one Clipboard Object may be open at any given time.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.