ProgressCounter()

  ProgressCounter

Description

ProgressCounter() is used to update a progress counter.

Call Signature

int ProgressCounter ( float completion [, string message] )

Return Value

int

The function returns 1 if the computation should continue, 0 if the user requested termination.

Arguments

float completion:

Percentage completion, specified as a fractional value between 0.0 and 1.0. A value of less than zero will reinitialize the counter and cause a 0% message to be emitted. Values greater than 1.0 will be clipped to 100%.

[ string message ]:

An optional message indicating what part of the work is being done.

Remarks

Note: Note the type of progress reporting performed depends on the value of the parameter MONITOR at the time EASI was invoked. If MONITOR="ON" a textual progress counter is printed to the terminal, if MONITOR="NET" the progress is sent over the network, otherwise if MONITOR="OFF" no progress reporting is performed.
Parent topic: EASI intrinsic functions
Previous topic: PCIDSKCreate()
Next topic: Random()

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.