Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

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

Chapter 7 - Classes and Methods / CyberStream

GetStreamError
Retrieves the first nontrivial error encountered by this Cyberdog stream.
OSErr GetStreamError ();
return value
The error code for the stream error.

DISCUSSION
This method should return a network error code for the first nontrivial error that the stream encountered, if any. The returned error code should be in the allowable range for Mac OS errors (including the Cyberdog and OpenDoc error ranges). If possible, you should use existing error codes instead of creating new error codes.
You determine whether an error has occurred in a stream by calling the GetStreamStatus method and testing the value of the kCDErrorOccurred flag. Typically, if a stream detects an error while downloading data, your display part should call the stream's Abort method to terminate the download and notify the user that the operation failed.
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 Abort method (page 381).
The GetStreamStatus method (page 385).