Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Three — Data Types and Operators (continued)

GetHandleType Function

Overview

The GetHandleType function returns the associated type code for a handle.

Syntax/Parameters

Syntax

dword = GetHandleType ( handle value );

Parameters

value

A handle for which to get the type.

Return Value

Returns an dword as a handle type or 0xFFFFFFFF on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The handle types are defined in the SDK.

  Name   Bitwise   Description  
  Types        
    SOT_LOCATION_MASK   0xFF000000   Location Mask  
    SOT_LOCAL   0x00000000   Local Object (0x00------)  
            (others types defined in SDK)  
  Base Object Types        
    SOT_BASIC_FILE_OBJECT   0x00000000   Basic File Object  
    SOT_MAPPED_TEXT_OBJECT   0x00000001   Mapped Text Object  
    SOT_EDIT_OBJECT   0x00000002   Edit Object  
    SOT_POOL_OBJECT   0x00000003   Pool Object  
    SOT_LOG_OBJECT   0x00000004   Log Object  
    SOT_WORD_PARSE_OBJECT   0x00000005   Word Parse Object  
    SOT_CSV_OBJECT   0x00000006   CSV Object  
    SOT_MD5_DIGEST_OBJECT   0x00000007   MD5 Digest Object  
    SOT_FOLDER_ENUM_OBJECT   0x00000008   Find File Object  
    SOT_FTP_OBJECT   0x00000009   FTP Communications Class  
    SOT_HTTP_OBJECT   0x0000000A   HTTP Communications Class  
    SOT_ZIP_OBJECT   0x0000000B   Compression Object  
    SOT_DATA_SHEET_OBJECT   0x0000000C   Data Sheet Object  
    SOT_CLIPBOARD_OBJECT   0x0000000D   Clipboard Object (base)  
    SOT_CONSOLE_WINDOW   0x0000000E   Console (Synthetic, is Window Handle)  
    SOT_DATA_OBJECT   0x0000000F   Data Object  

 

Additional handle types are provided for and located in LegatoDefaultSDK.h. Depending on the implementation of Legato, the types may or may not be available.

Related Functions

CloseHandle — Closes an object handle and releases any associated resources.

GetHandleCount — Returns a count of all open managed handles.

IsValidHandle — Tests a handle value as being a valid Legato object handle.

IsWindowHandleValid — Tests a handle value as being a valid window handle.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.