Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

ProgressClose Function

Overview

The ProgressClose function closes an open progress window.

Syntax/Parameters

Syntax

int = ProgressClose ( );

Parameters

(none)

Return Value

Returns an int as ERROR_NONE if the function succeeds or -1 if the function fails. Use the GetLastError function to retrieve error information.

Remarks

A script cannot close a progress window that it did not open. Opening a second progress window while a first is open will automatically close the first. The script ending will also automatically close an open progress window.

If no progress window is open or if the progress window is owned by another process when the ProgressClose function is called, the GetLastError function will return ERROR_SOFT.

When attached to the application’s current progress window, ProgressClose releases the attachment and leaves the application progress window open.

Related Functions

Platform Support

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

Legato IDE, Legato Basic