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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ProgressSetStatus Function

Overview

The ProgressSetStatus function displays a status message within a progress window.

Syntax/Parameters

Syntax

int = ProgressSetStatus ( [int type], string message, [parameters ...] );

Parameters

type

An optional int containing information about how to display message. For example, a value of 1 would display message on the first line of the progress window. If the value is omitted, the status is displayed on the first line. Most progress boxes have two lines available.

message

A string containing a message.

parameters

Optional parameters, which may contain additional information to display.

Return Value

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

Remarks

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

If the application progress is being used, it is customary to set status only on the second line since the first is usually controlled by the application.

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.

ProgressSetCaption — Sets/resets the progress caption.

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.