Foxit PDF Conversion SDK

Public 成员函数 | 所有成员列表
IFX_FileStream类 参考abstract
FXCRT

文件流接口，用于读取和写入。 更多...

类 IFX_FileStream 继承关系图:

## Public 成员函数
virtual FX_BOOL | Flush ()=0
| 刷新内部缓冲区。 更多...
virtual FX_INT64 | GetPosition ()=0
| 获取流中当前的读取位置。 更多...
virtual FX_INT64 | GetSize ()=0
| 获取当前流的大小，以字节为单位。 更多...
virtual FX_BOOL | IsEOF ()=0
| 确定是否到达流的末尾。 更多...
virtual FX_BOOL | ReadBlock (void *buffer, FX_INT64 offset, size_t size)=0
| 从流中读取数据块。 更多...
virtual size_t | ReadBlock (void *buffer, size_t size)=0
| 从流中读取数据块。 更多...
virtual void | Release ()=0
| 销毁当前实例。 更多...
virtual IFX_FileStream * | Retain ()=0
| 创建共享实例。 更多...
virtual FX_BOOL | WriteBlock (const void *buffer, FX_INT64 offset, size_t size)=0
| 将数据块写入流中。 更多...
virtual FX_BOOL | WriteBlock (const void *buffer, size_t size)
| 将数据块写入当前流的末尾。 更多...
Public 成员函数 继承自 IFX_FileRead
virtual void | ClearRange ()
| 清除由函数 IFX_FileRead::SetRange 设置的访问范围。 更多...
virtual FX_INT64 | SetPosition (FX_INT64 pos)
| 设置当前文件访问位置。 更多...
virtual FX_BOOL | SetRange (FX_INT64 offset, FX_INT64 size)
| 设置访问范围。 更多...

## 详细描述

文件流接口，用于读取和写入。

## 成员函数说明

## ◆ Flush()

virtual FX_BOOL IFX_FileStream::Flush | ( |  | ) |
| pure virtual

刷新内部缓冲区。

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

实现了 IFX_FileWrite.

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ GetPosition()

virtual FX_INT64 IFX_FileStream::GetPosition | ( |  | ) |
| pure virtual

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

返回
  当前读取位置。

重载 IFX_FileRead .

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ GetSize()

virtual FX_INT64 IFX_FileStream::GetSize | ( |  | ) |
| pure virtual

获取当前流的大小，以字节为单位。

返回
  当前流的大小，以字节为单位。

实现了 IFX_FileWrite.

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ IsEOF()

virtual FX_BOOL IFX_FileStream::IsEOF | ( |  | ) |
| pure virtual

确定是否到达流的末尾。

返回
  true表示到达流的末尾，false表示还没有到达。

重载 IFX_FileRead .

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ ReadBlock() [1/2]

virtual FX_BOOL IFX_FileStream::ReadBlock | ( | void * | buffer,
|  | FX_INT64 | offset,
|  | size_t | size
| ) |  |
| pure virtual

从流中读取数据块。

参数

  [in,out] | buffer | 指向接收数据的缓冲区的指针。
  [in] | offset | 从文件开头的字节偏移量，即读取数据的位置。
  [in] | size | 要从流中读取的字节数。

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

实现了 IFX_FileRead.

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ ReadBlock() [2/2]

virtual size_t IFX_FileStream::ReadBlock | ( | void * | buffer,
|  | size_t | size
| ) |  |
| pure virtual

从流中读取数据块。

参数

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

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

重载 IFX_FileRead .

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ Release()

virtual void IFX_FileStream::Release | ( |  | ) |
| pure virtual

销毁当前实例。

返回
  无。

实现了 IFX_FileWrite.

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ Retain()

virtual IFX_FileStream* IFX_FileStream::Retain | ( |  | ) |
| pure virtual

创建共享实例。

返回
  文件流接口。

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ WriteBlock() [1/2]

virtual FX_BOOL IFX_FileStream::WriteBlock | ( | const void * | buffer,
|  | FX_INT64 | offset,
|  | size_t | size
| ) |  |
| pure virtual

将数据块写入流中。

参数

  [in] | buffer | 指向数据块的指针。
  [in] | offset | 从文件开头的字节偏移量，即写入数据的位置。
  [in] | size | 缓冲区的长度，以字节为单位。

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

实现了 IFX_FileWrite.

在 CFX_CachedFileRead , 以及 IFX_ChunkFileStream 内被实现.

## ◆ WriteBlock() [2/2]

virtual FX_BOOL IFX_FileStream::WriteBlock | ( | const void * | buffer,
|  | size_t | size
| ) |  |
| inline virtual

将数据块写入当前流的末尾。

参数

  [in] | buffer | 指向数据块的指针。
  [in] | size | 缓冲区的长度，以字节为单位。

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

重载 IFX_FileWrite .

被 IFX_ChunkFileStream 重载.