IFX_FileRead类 参考

文件读取接口。 更多...

类 IFX_FileRead 继承关系图:

Public 成员函数
virtual void	ClearRange ()
	清除由函数 IFX_FileRead::SetRange 设置的访问范围。 更多...
virtual FX_INT64	GetPosition ()
	获取流中当前的读取位置。 更多...
virtual FX_INT64	GetSize ()=0
	获取文件的总大小。 更多...
virtual FX_BOOL	IsEOF ()
	确定是否到达流的末尾。 更多...
virtual FX_BOOL	ReadBlock (void *buffer, FX_INT64 offset, size_t size)=0
	从文件中读取数据块。 更多...
virtual size_t	ReadBlock (void *buffer, size_t size)
	从流中读取数据块。 更多...
virtual void	Release ()=0
	释放所有资源时调用 更多...
virtual FX_INT64	SetPosition (FX_INT64 pos)
	设置当前文件访问位置。 更多...
virtual FX_BOOL	SetRange (FX_INT64 offset, FX_INT64 size)
	设置访问范围。 更多...

详细描述

文件读取接口。

成员函数说明

ClearRange()

virtual void IFX_FileRead::ClearRange ( )

inlinevirtual

清除由函数 IFX_FileRead::SetRange 设置的访问范围。

返回

无。

GetPosition()

virtual FX_INT64 IFX_FileRead::GetPosition ( )

inlinevirtual

获取流中当前的读取位置。

返回

流中当前的读取位置。

实现了 IFX_StreamRead.

被 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 重载.

GetSize()

virtual FX_INT64 IFX_FileRead::GetSize ( )

pure virtual

获取文件的总大小。

返回

文件大小，以字节为单位。实现可以在任何错误时返回0。

在 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 内被实现.

IsEOF()

virtual FX_BOOL IFX_FileRead::IsEOF ( )

inlinevirtual

确定是否到达流的末尾。

返回

true 表示到达流的末尾，false 表示尚未到达。

实现了 IFX_StreamRead.

被 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 重载.

ReadBlock() [1/2]

virtual FX_BOOL IFX_FileRead::ReadBlock ( void *  buffer, FX_INT64  offset, size_t  size  )

pure virtual

从文件中读取数据块。

参数

[in,out]	buffer	指向接收读取数据的缓冲区的指针
[in]	offset	从文件开头开始的字节偏移量
[in]	size	块的字节数。

返回

true 表示成功，false 表示失败。

在 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 内被实现.

ReadBlock() [2/2]

virtual size_t IFX_FileRead::ReadBlock ( void *  buffer, size_t  size  )

inlinevirtual

从流中读取数据块。

参数

[in,out]	buffer	存储数据的缓冲区。
[in]	size	缓冲区的总大小，以字节为单位。

返回

存储在缓冲区中的数据长度。如果返回0，表示错误或没有数据。

实现了 IFX_StreamRead.

被 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 重载.

Release()

virtual void IFX_FileRead::Release ( )

pure virtual

释放所有资源时调用

返回

无。

实现了 IFX_StreamRead.

在 CFX_CachedFileRead, IFX_ChunkFileStream , 以及 IFX_FileStream 内被实现.

SetPosition()

virtual FX_INT64 IFX_FileRead::SetPosition ( FX_INT64  pos )

inlinevirtual

设置当前文件访问位置。

参数

[in]

pos

新的访问位置。

返回

从文件开头开始的当前文件访问位置。默认值：-1，表示不支持。

重载 IFX_StreamRead .

SetRange()

virtual FX_BOOL IFX_FileRead::SetRange ( FX_INT64  offset, FX_INT64  size  )

inlinevirtual

设置访问范围。

参数

[in]	offset
[in]	size

返回

true 表示成功，false 表示失败。