Legacy Document

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

Chapter 7 - Classes and Methods / CyberProgressBroadcaster

GetStatusString

Retrieves the status string associated with an asynchronous process.

void GetStatusString (in StringPtr statusStr);

statusStr

A pointer to a string buffer. On return, the buffer contains the status string.

DISCUSSION

The GetStatusString method returns a pointer to the last status string set by the SetStatusString method or an empty string if SetStatusString has not been called since the object was initialized or reset.

Typically, the status string describes what the process is currently doing. For example, if an asynchronous process is downloading data, GetStatusString might return the string "Downloading".

SEE ALSO

The SetStatusString method (page 312).