FDO API Reference | Feature Data Objects |
#include <Stream.h>
Inherits FdoDisposable.
Inherited by FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream.
Inheritance diagram for FdoIoStream:
Definition at line 31 of file Stream.h.
Public Member Functions | |
virtual FDO_API_COMMON FdoBoolean | CanRead () |
gets the reading capability. | |
virtual FDO_API_COMMON FdoBoolean | CanWrite () |
gets the writing capability. | |
virtual FDO_API_COMMON FdoInt64 | GetIndex ()=0 |
gets the current position for the stream. | |
virtual FDO_API_COMMON FdoInt64 | GetLength ()=0 |
gets the current length of the stream. | |
virtual FDO_API_COMMON FdoBoolean | HasContext () |
returns whether the stream has any positional context. Streams without context can only be read and written in a forward-only manner. These streams do not allow position and length changes. | |
virtual FDO_API_COMMON FdoSize | Read (FdoByte *buffer, FdoSize count)=0 |
reads the number of bytes indicated by count into the given buffer, or the number of bytes after the current stream position, whichever is less. The stream’s current position is moved ahead by the number of bytes read. | |
virtual FDO_API_COMMON void | Reset ()=0 |
sets the position to the start of the stream. | |
virtual FDO_API_COMMON void | SetLength (FdoInt64 length)=0 |
truncates the stream to the indicated length. | |
virtual FDO_API_COMMON void | Skip (FdoInt64 offset)=0 |
skips over part of the stream. | |
virtual FDO_API_COMMON void | Write (FdoIoStream *stream, FdoSize count=0)=0 |
reads the number of bytes from the given stream, and writes them to this stream. | |
virtual FDO_API_COMMON void | Write (FdoByte *buffer, FdoSize count)=0 |
writes the number of bytes indicated by count, from the given buffer, to the stream. The current position is moved ahead by the number of bytes written. |
|
gets the reading capability.
Reimplemented in FdoIoFileStream. Definition at line 131 of file Stream.h. References FDO_API_COMMON, and FdoBoolean. |
|
gets the writing capability.
Reimplemented in FdoIoFileStream. Definition at line 142 of file Stream.h. References FDO_API_COMMON, and FdoBoolean. |
|
gets the current position for the stream.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
gets the current length of the stream.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
returns whether the stream has any positional context. Streams without context can only be read and written in a forward-only manner. These streams do not allow position and length changes.
Reimplemented in FdoIoFileStream. Definition at line 157 of file Stream.h. References FDO_API_COMMON, and FdoBoolean. |
|
reads the number of bytes indicated by count into the given buffer, or the number of bytes after the current stream position, whichever is less. The stream’s current position is moved ahead by the number of bytes read.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
sets the position to the start of the stream.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
truncates the stream to the indicated length.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
skips over part of the stream.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
reads the number of bytes from the given stream, and writes them to this stream.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
|
writes the number of bytes indicated by count, from the given buffer, to the stream. The current position is moved ahead by the number of bytes written.
Implemented in FdoIoBufferStream, FdoIoFileStream, and FdoIoMemoryStream. |
Comments or suggestions? Send us feedback. |