GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ProgressSetPhaseCount Function

Overview

The ProgressSetPhaseCount function allows progress updating to occur in phases in a progress window. The update value is still 0-100% for each phase, but this relieves the script from having to calculate the bar position during multi-phase operations.

Syntax/Parameters

Syntax

int = ProgressSetPhaseCount ( int phases );

Parameters

phases

An int containing the number of phases into which progress should be divided.

Return Value

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

Remarks

Use the ProgressSetPhase function to advance one or more phases. Note that the progress bar will not advance unless the ProgressUpdate function is called.

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

Programmers should use caution setting or changing phases when the progress window belongs to the application. See AttachApplicationProgress.

Related Functions

AttachApplicationProgress — Attaches the application's open progress to the script.

IsProgressOpen — Tests to see if progress is open by the script.

ProgressOpen — Opens the Progress dialog with caption, delay and options.

ProgressSetPhase — Sets or advances the current phase.

ProgressUpdate — Updates the progress percentage (checks cancel). Sets to a specified percentage or to a percentage of two values to calculate progress.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.