Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ThreeData Types and Operators (continued)

IsValidHandle Function

Overview

The IsValidHandle function checks a handle value to see if it is open and valid.

Syntax/Parameters

Syntax

boolean = IsValidHandle ( handle handle );

Parameters

handle

A handle value as retrieved from functions such as the OpenFile or LogCreate functions.

Return Value

Returns a boolean value as TRUE if the function handle is valid or FALSE if it is not.

Remarks

This function scans the internal object table for the handle value. If the handle exists, the function will return TRUE.

Non-Legato handles are not tested and will return FALSE (unless, by chance, the value matches a valid handle, for example, a window handle happens to match). While a match is unlikely, programmers are cautioned not to mix Windows and other handles with Legato handles.

The handle value NULL_HANDLE and INVALID_HANDLE_VALUE are always invalid.

Related Functions

Platform Support

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

Legato IDE, Legato Basic