Legacy Document

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

Chapter 7 - Classes and Methods / CyberStream

GetTotalDataSize

Retrieves the total size, in bytes, of the data available to be downloaded by this Cyberdog stream.

long GetTotalDataSize ();

return value

The number of bytes downloaded by the stream.

DISCUSSION

This method should return the total number of bytes downloaded by a stream object. You can determine whether the total size is available by calling the IsTotalDataSizeAvailable method.

GetTotalDataSize should return the constant kCDTotalDataSizeUnknowable if the number of bytes to be downloaded will never be available or if total data size does not make sense for the protocol implemented by the stream. GetTotalDataSize should return the constant kCDTotalDataSizeUnknown if the number of bytes to be downloaded is not known, but may be known at a later time.

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

SEE ALSO

The IsTotalDataSizeAvailable method (page 388).