Legacy Document

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

Chapter 7 - Classes and Methods / CyberProgressBroadcaster

GetAmountTotal

Retrieves a value representing the total amount of work to be completed by an asynchronous process.

void GetAmountTotal (out long amtTotal);

amtTotal

The total amount of work to be completed.

DISCUSSION

The GetAmountTotal method returns a value that represents the total amount of work to be performed by the process. GetAmountTotal returns the last value set by the SetAmountTotal method or 0 if SetAmountTotal has not been called since the object was initialized or reset. The amount done, set by the SetAmountDone method, is specified relative to the total amount as set by the SetAmountTotal method.

The value in the amtTotal parameter is a numeric indication of the total amount of work to be performed. For example, consider the process of downloading 200 bytes of data. In this case, the total amount is 200.

SEE ALSO

The GetAmountDone method (page 302).
The GetProgressPercent method (page 305).
The SetAmountDone method (page 308).
The SetAmountTotal method (page 309).
The SetProgressPercent method (page 311).