Legacy Document

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

Chapter 7 - Classes and Methods / CyberProgressBroadcaster

GetAmountDone

Retrieves a value representing what portion of an asynchronous process has been completed.

void GetAmountDone (out long amtDone);

amtDone

A numeric indication of the portion of the process that has been completed.

DISCUSSION

This method returns the last value set by the SetAmountDone method or 0 if SetAmountDone has not been called since the object was initialized or reset. The amount done is relative to the total amount as set by the SetAmountTotal method.

The value in the amtDone parameter is a numeric indication of the amount done. For example, consider the process of downloading 200 bytes of data. If you have downloaded 100 bytes, the amount done is 100.

SEE ALSO

The GetAmountTotal method (page 303).
The GetProgressPercent method (page 305).
The SetAmountDone method (page 308).
The SetAmountTotal method (page 309).
The SetProgressPercent method (page 311).