Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter TwoLanguage Overview (continued)

ConsoleCreate Function

Overview

The ConsoleCreate function creates a separate console window and returns a console handle.

Syntax/Parameters

Syntax

handle = ConsoleCreate ( int id, [string caption], [string properties] );

Parameters

id

An int specifying the console index from 1-7. Using -1 will create the next available console position. A console at the index specified by id cannot already be open. If so, the returned handle will be the existing window.

caption

An optional string specifying the caption for the console window. If omitted or empty, the default caption will be used.

properties

An optional string containing parameters that define or change the look and operation of the console window. See ConsoleOpen for details and parameter options.

Return Value

Returns a handle for the console window or NULL_HANDLE on failure. Use the GetLastError function to retrieve a formatted error code. If a window is already open at the position specified by id, the handle for that window is returned.

Remarks

Multiple console windows are only supported in a Windows environment. If the particular window has already been created, the window handle to that console is returned and any additional parameters are ignored. A windows application can have up to eight console windows, including the default console. Extra console windows do not operate in console mode.

Console window handles are, by default, the actual window handle value. The handle can also be the console index, from 0-7. If a script starts and always wants to continue with console window 2, it can use the index rather than the handle, or it can create 2 and the window handle will be returned.

Related Functions

Platform Support

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

Legato IDE, Legato Basic