Foxit PDF SDK

构造函数 | 类方法 | 所有成员列表
FSPDFStream类 参考
类 FSPDFStream 继承关系图:

## 构造函数
(id< FSFileReaderCallback >) | - exportData:
| 导出流数据。 更多...
(NSData *) | - getData:
| 获取流数据。 更多...
(unsigned long long) | - getDataSize:
| 获取流数据的大小，以字节为单位。 更多...
(FSPDFDictionary *) | - getDictionary
| 获取与当前PDF流对象关联的PDF字典对象。 更多...
(FSPDFStreamFilter) | - getStreamFilter
| 获取流过滤器的类型，该类型指示在使用数据之前必须如何解码流数据。 更多...
(void) | - importData:stream_filter:
| 导入流数据。 更多...
(void) | - setData:
| 设置流数据。 更多...
构造函数 继承自 FSPDFObject
(FSPDFObject *) | - cloneObject
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
(FSPDFObject *) | - deepCloneObject
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
(void) | - destroy
| 释放新创建的PDF对象或克隆PDF对象， 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...
(FSPDFArray *) | - getArray
| 获取当前PDF对象的PDF数组对象。 更多...
(BOOL) | - getBoolean
| 获取当前PDF对象的布尔值。 更多...
(FSDateTime *) | - getDateTime
| 获取当前PDF对象的日期时间值。 更多...
(FSPDFDictionary *) | - getDict
| 获取当前PDF对象的PDF字典对象。 更多...
(FSPDFObject *) | - getDirectObject
| 获取当前PDF对象的直接对象。 更多...
(float) | - getFloat
| 获取当前PDF对象的浮点数值。 更多...
(int) | - getInteger
| 获取当前PDF对象的整数值。 更多...
(FSMatrix2D *) | - getMatrix
| 获取当前PDF对象的矩阵值。 更多...
(NSString *) | - getName
| 获取当前PDF对象的名称值。 更多...
(unsigned int) | - getObjNum
| 获取当前PDF对象的间接对象编号。 更多...
(FSRectF *) | - getRect
| 获取当前PDF对象的矩形值。 更多...
(FSPDFStream *) | - getStream
| 获取当前PDF对象的PDF流对象。 更多...
(NSData *) | - getString
| 获取当前PDF对象的字符串值。 更多...
(FSPDFObjectType) | - getType
| 获取当前PDF对象的类型。 更多...
(NSString *) | - getWideString
| 获取当前PDF对象的宽字符串值。 更多...
(BOOL) | - isIdentical:
| 检查输入的PDF对象是否与当前PDF对象相同。 更多...

## 类方法
(FSPDFStream *) | + create:
| 基于字典创建新的流对象。 更多...
类方法 继承自 FSPDFObject
(FSPDFObject *) | + createFromBoolean:
| 从布尔值创建PDF对象。 更多...
(FSPDFObject *) | + createFromDateTime:
| 从日期时间创建PDF对象。 更多...
(FSPDFObject *) | + createFromFloat:
| 从浮点数创建PDF对象。 更多...
(FSPDFObject *) | + createFromInteger:
| Create a PDF object from a integer number. 更多...
(FSPDFObject *) | + createFromName:
| 从表示名称的字符串创建PDF对象。 更多...
(FSPDFObject *) | + createFromNameW:
| 从表示名称的字符串创建PDF对象。 更多...
(FSPDFObject *) | + createFromString:
| 从字符串创建PDF对象。 更多...
(FSPDFObject *) | + createFromStringWithLength:length:
| 从字符串创建PDF对象。 更多...
(FSPDFObject *) | + createReference:object_number:
| 为间接对象创建引用。 更多...

## 详细描述

PDF流对象由一个直接字典对象和流数据组成。 有关更多详细信息，请参阅<PDF Reference 1.7>中的第3.2.7节“流对象”。
类FSPDFStream派生自FSPDFObject ，并提供函数来创建新的PDF流对象以及 获取/设置流数据。

参见
  FSPDFObject

## 函数文档

## ◆ create:()

+ (FSPDFStream *) create: |  | (FSPDFDictionary*) | dictionary |

基于字典创建新的流对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用， 请调用函数FSPDFObject::destroy来释放该对象。

参数

  [in] | dictionary | 一个PDF字典对象： 如果为nil，将基于 空的PDF字典创建PDF流对象。 如果不是nil，在成功创建PDF流对象后， 请勿对此PDF字典对象调用FSPDFObject::destroy。

返回
  一个新的FSPDFStream 对象。如果有任何错误，此函数将返回nil。

## ◆ exportData:()

- (id< FSFileReaderCallback >) exportData: |  | (BOOL) | is_raw_data |

导出流数据。

此函数提供了一种高效的方式来获取流数据，尤其是对于大型流数据。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： YES表示获取原始数据，NO表示 获取解码后的数据（原始数据）。

返回
  一个FSFileReaderCallback对象，可用于读取流数据。 请记得使用返回的FSFileReaderCallback对象的Release()回调函数 来释放此FSFileReaderCallback对象，当不再使用它时。

注解
  如果当前流对象被释放或相关PDF文档被关闭， 请勿再使用返回的FSFileReaderCallback对象；否则，将发生意外错误或崩溃。

## ◆ getData:()

- (NSData *) getData: |  | (BOOL) | is_raw_data |

获取流数据。

调用此函数时，用户应传递一个具有足够大小的内存块来检索数据。 建议用户调用函数FSPDFStream::getDataSize:（使用相同的参数 is_raw_data）来获取预期大小，然后准备内存块，然后 调用此函数来获取数据。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： YES表示获取原始数据，NO表示 获取解码后的数据（原始数据）。

返回
  YES表示成功，而NO表示失败。

## ◆ getDataSize:()

- (unsigned long long) getDataSize: |  | (BOOL) | is_raw_data |

获取流数据的大小，以字节为单位。

参数

  [in] | is_raw_data | 一个布尔值，指示是否获取原始数据： YES表示获取原始数据，NO表示 获取解码后的数据（原始数据）。

返回
  数据大小，以字节为单位。

## ◆ getDictionary()

- (FSPDFDictionary *) getDictionary |  |  |

获取与当前PDF流对象关联的PDF字典对象。

返回
  流字典。 如果有任何错误，此函数将返回nil。

## ◆ getStreamFilter()

- (FSPDFStreamFilter) getStreamFilter |  |  |

获取流过滤器的类型，该类型指示在使用数据之前必须如何解码流数据。

返回
  流过滤器的类型。请参考从FSPDFStreamUnknown开始的值， 此值将是这些值之一。

## ◆ importData:stream_filter:()

- (void) importData: |  | (id<FSFileReaderCallback>) | file_read
stream_filter: |  | (FSPDFStreamFilter) | stream_filter

导入流数据。

参数

  [in] | file_read | 一个由用户实现的FSFileReaderCallback对象。Foxit PDF SDK将使用它来 读取流数据并设置到当前PDF流对象。用户应保持 此回调有效，直到相关的PDF文档关闭或当前流对象 因无用而被释放。
  [in] | stream_filter | 流过滤器的类型，指定如何解码通过参数file_read读取的数据。 请参考从FSPDFStreamNoneDecode开始的值，此值应是这些值之一，但 FSPDFStreamUnknown除外。

返回
  无。

## ◆ setData:()

- (void) setData: |  | (NSData *) | buffer |

设置流数据。

参数

  [in] | buffer | 一个内存块，表示要设置的新流数据。

返回
  无。