Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

LoadBitmap Function

Overview

The LoadBitmap function loads a bitmap as resource or file and returns a Resource Object handle.

Syntax/Parameters

Syntax

handle = LoadBitmap ( string resource );

Parameters

resource

A string specifying a resource name or a filename. If the string contains illegal characters for a resource name (such as a ‘.’), it is assumed to be a filename. If the filename is not qualified, the script folder is used as a basis to qualify the path.

Return Value

A handle to a Resource Object or NULL_HANDLE on error. Use the GetLastError function to retrieve a formatted error code.

Remarks

If a file is referenced, once it is loaded, the file is released. If the resource object is handed to a window control or other item, the object should remain intact until the referencing window or object no longer needs the image. Using the CloseHandle function or if the handle is automatically closed will release all the resources and internal handles associated with the object.

Selection of an incorrect image format or other encoding errors will resource in an error being returned.

Related Functions

Platform Support

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

Legato IDE, Legato Basic