Legacy Document

Inside Macintosh: Cyberdog Programmer's Kit / Part 3 - Cyberdog Reference

Chapter 7 - Classes and Methods / CyberProgressBroadcaster

GetProgressMode

Retrieves the progress mode for an asynchronous process.

void GetProgressMode (out short mode);

mode

The progress mode of the process. Valid values for this parameter are kUnmeteredProgress and kMeteredProgress.

DISCUSSION

The GetProgressMode method returns the last value set by the SetProgressMode method or kUnmeteredProgress if SetProgressMode has not been called since the object was initialized or reset.

The progress mode of the process indicates whether the total amount of work to be performed is known and can be measured. For example, if you know in advance the number of bytes to be downloaded, the progress mode is metered. In contrast, if you don't know in advance the number of bytes to be downloaded, the progress mode is unmetered. The default progress mode is unmetered.

SEE ALSO

The SetProgressMode method (page 310).