Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

ProgressSetPhase Function

Overview

The ProgressSetPhase function alters the phase of the progress window.

Syntax/Parameters

Syntax

int = ProgressSetPhase ( [int phase] );

Parameters

phase

An optional int containing a phase count value.

Return Value

Returns an int as ERROR_NONE on success or -1 on error. Use the GetLastError function to retrieve error information.

Remarks

If the phase parameter is omitted, the ProgressSetPhase function automatically advances the progress window to the next phase. The number of phases is set by the ProgressSetPhaseCount function.

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

Related Functions

Platform Support

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

Legato IDE, Legato Basic