GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ProgressOpen Function

Overview

The ProgressOpen function displays a progress window.

Syntax/Parameters

Syntax

int = ProgressOpen ( [string caption], [int delay], [dword options] );

Parameters

caption

An optional string containing the caption for the window.

delay

An int containing a number of milliseconds to wait before displaying the progress window. If omitted, the default is 500 milliseconds (.5 secs).

options

An optional dword containing optional specification of bitwise hexadecimal flags. If omitted, the default value is PW_SMALL_BOX_STYLE. See Remarks below.

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 can only have one progress window open at any time. The script ending will automatically close an open progress window.

The style and operation of the progress windows is determined by the options parameter. The following are the acceptable bitwise values: 

	Value		Code		Comment
	PW_BAR_DEFAULT		0x00000000		Default progress bar.
	PW_BAR_XP_STYLE		0x00000020		Windows XP style. Otherwise use the theme.
	PW_NO_CANCEL		0x00000001		No cancel/disable cancel button.
	PW_NO_YIELD		0x00000002		Do not yield for messages.
	PW_BAR_NO_PERCENT		0x00000004		No percentage bar.
	PW_STANDARD_BOX_STYLE		0x00000000		Standard box (default).
	PW_SMALL_BOX_STYLE		0x00000100		Small box style (no visible cancel).
	PW_LARGE_BOX_STYLE		0x00000200		Large box style (i.e., file transfer).
	PW_HIDE_CAPTION		0x00001000		Hide caption (shrinks caption).
	PW_APPLICATION_LOG		0x00002000		Post to application log.
	PW_INHIBIT_PROGRESS		0x01000000		Do not display progress updates.

If the progress window is owned by another process when the ProgressOpen function is called, the GetLastError function will return ERROR_SOFT.

Related Functions

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

IsApplicationProgressOpen — Tests to see if the shared progress is open within the application.

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

ProgressClose — Closes the progress display (only if the script owns the progress display).

ProgressDisableCancel — Disables the cancel function.

ProgressSetCaption — Sets/resets the progress caption.

ProgressSetPhase — Sets or advances the current phase.

ProgressSetPhaseCount — Sets the total number of phases.

ProgressSetStatus — Sets a status message to a specified field.

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 12/16/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.