  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Three — Data Types and Operators (continued)
Overview
The MakeHandle function takes a string or integer value, processes it, and turns it into a handle.
Syntax/Parameters
Syntax
handle = MakeHandle ( string value | int value );
Parameters
value
As a string, the value is translated from the string representation of the value handle. The value can be in hex as prefixed by ‘0x’, octal as prefixed by ‘0’, or decimal. The string can also be a complex handle with a trailing object type descriptor. Or,
As an int, the value is translated from the 32-bit portion of the value.
Return Value
Returns a handle value or NULL_HANDLE on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The MakeHandle function is useful for retrieving handles from parameter lists and other data to convert and typecast information in the form of a handle. For example, the MakeHandle function can be useful when reading a menu function response and converting the returned handle to an Information View tab window.
The MakeHandle function is a very mechanical function that simply converts a number into a handle type. It does not test the suitability of the returned value.
The complex type will allow the handle to be registered and used with certain API objects. This is generally how an object can be passed from the parent application to a hook. Not all candidate object handles has tested for quality so caution should be observed. Failure to set up a correct handle type may result in program exception or run time error.
If a complex handle is not provided, handle value is not implied to be any specific type of object or window.
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.