File reading interface.
More...
◆ ClearRange()
virtual void IFX_FileRead::ClearRange |
( |
| ) |
|
|
inlinevirtual |
◆ GetPosition()
virtual FX_INT64 IFX_FileRead::GetPosition |
( |
| ) |
|
|
inlinevirtual |
◆ GetSize()
virtual FX_INT64 IFX_FileRead::GetSize |
( |
| ) |
|
|
pure virtual |
◆ IsEOF()
virtual FX_BOOL IFX_FileRead::IsEOF |
( |
| ) |
|
|
inlinevirtual |
◆ ReadBlock() [1/2]
virtual FX_BOOL IFX_FileRead::ReadBlock |
( |
void * |
buffer, |
|
|
FX_INT64 |
offset, |
|
|
size_t |
size |
|
) |
| |
|
pure virtual |
Read a data block from the file.
- Parameters
-
[in,out] | buffer | Pointer to a buffer receiving read data |
[in] | offset | Byte offset from beginning of the file |
[in] | size | Number of bytes for the block. |
- Returns
- true means success, and false means failure.
Implemented in CFX_CachedFileRead, and IFX_FileStream.
◆ ReadBlock() [2/2]
virtual size_t IFX_FileRead::ReadBlock |
( |
void * |
buffer, |
|
|
size_t |
size |
|
) |
| |
|
inlinevirtual |
Read data block from stream.
- Parameters
-
[in,out] | buffer | Buffer to store data. |
[in] | size | Total size of buffer, in bytes. |
- Returns
- The length of data stored in buffer. If returns 0, that means error or no data.
Implements IFX_StreamRead.
Reimplemented in CFX_CachedFileRead, and IFX_FileStream.
◆ Release()
virtual void IFX_FileRead::Release |
( |
| ) |
|
|
pure virtual |
◆ SetPosition()
virtual FX_INT64 IFX_FileRead::SetPosition |
( |
FX_INT64 |
pos | ) |
|
|
inlinevirtual |
Set the current file accessing position.
- Parameters
-
[in] | pos | The new accessing position. |
- Returns
- The current file accessing position from the beginning of file. Default value:-1, means Unsupport.
Reimplemented from IFX_StreamRead.
◆ SetRange()
virtual FX_BOOL IFX_FileRead::SetRange |
( |
FX_INT64 |
offset, |
|
|
FX_INT64 |
size |
|
) |
| |
|
inlinevirtual |
Set accessing range.
- Parameters
-
- Returns
- true means success, and false means failure.