Legacy Document

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

Chapter 7 - Classes and Methods / CyberStream

GetStatusString

Retrieves a string describing the current status of this Cyberdog stream.

void GetStatusString (in Str255 message);

message

A 255-character buffer. On return, the buffer contains the status string.

DISCUSSION

This method should retrieve a string that describes the current status of the stream. This method may return an error string if the kCDErrorOccurred flag is set to true. If you are using a progress part to display status and progress of the stream, you can pass the status string to CyberProgressBroadcaster::SetStatusString.

You can detect whether a stream's status string has changed by calling the GetStreamStatus method and testing the value of the kCDStatusStringChanged flag.

If you subclass CyberStream, you must override this method. Your override must not call its inherited method; that is, your override method must implement this method's functionality completely.

SEE ALSO

The StreamStatus type (page 179).
The GetStreamStatus method (page 385).
The CyberProgressBroadcaster::SetStatusString method (page 312).