| VirtualBox Main API
    | 
The IDataStream interface is used to retrieve a data stream. More...
 
 | Public Member Functions | |
| void | read (in unsigned long size, in unsigned long timeoutMS, [retval] out octet[] data) | 
| Read data from the stream. | |
| Public Attributes | |
| readonly attribute unsigned long | readSize | 
| Recommended size of a read. | |
The IDataStream interface is used to retrieve a data stream.
It is returned by IMediumIO::convertToStream.
{A338ED20-58D9-43AE-8B03-C1FD7088EF15} | void IDataStream::read | ( | in unsigned long | size, | 
| in unsigned long | timeoutMS, | ||
| [retval] out octet[] | data | ||
| ) | 
Read data from the stream.
| size | How many bytes to try read. | 
| timeoutMS | Timeout (in ms) for limiting the wait time for data to be available. Pass 0 for an infinite timeout. | 
| data | Array of data read. This may be shorter than the specified size. Returning a zero-sized array indicates the end of the stream, if the status is successful. | 
| VBOX_E_TIMEOUT | Waiting time has expired. | 
| readonly attribute unsigned long IDataStream::readSize | 
Recommended size of a read.
Requesting a larger read may be possible in certain situations, but it is not guaranteed.