fsdk.PDFStream类 参考

Public 成员函数
def	ExportData (is_raw_data)
	导出流数据。 更多...
def	GetData (is_raw_data, size, out_buffer)
	获取流数据。 更多...
def	GetDataSize (is_raw_data)
	获取流数据的大小，以字节为单位。 更多...
def	GetDictionary ()
	获取与当前PDF流对象关联的PDF字典对象。 更多...
def	GetStreamFilter ()
	获取流过滤器的类型，该类型指示在使用数据之前必须如何解码流数据。 更多...
def	ImportData (file_read, stream_filter)
	导入流数据。 更多...
def	SetData (buffer, size)
	设置流数据。 更多...

详细描述

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

参见

PDFObject

成员函数说明

ExportData()

def fsdk.PDFStream.ExportData

(

is_raw_data

)

导出流数据。

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

参数

[in]

is_raw_data

一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。

返回

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

注解

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

GetData()

def fsdk.PDFStream.GetData	(		is_raw_data,
			size,
			out_buffer
	)

获取流数据。

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

参数

[in]	is_raw_data	一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。
[in]	size	参数out_buffer的大小，以字节为单位。 它应该等于或大于实际数据大小。
[out]	out_buffer	一个内存块（具有足够的大小）用作输出参数来接收流数据。 它不应为null。

返回

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

GetDataSize()

def fsdk.PDFStream.GetDataSize

(

is_raw_data

)

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

参数

[in]

is_raw_data

一个布尔值，指示是否获取原始数据： true表示获取原始数据，false表示 获取解码后的数据（原始数据）。

返回

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

GetDictionary()

def fsdk.PDFStream.GetDictionary

(

)

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

返回

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

GetStreamFilter()

def fsdk.PDFStream.GetStreamFilter

(

)

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

返回

流过滤器的类型。请参考从 fsdk.PDFStreamE_Unknown 开始的值， 此值将是这些值之一。

ImportData()

def fsdk.PDFStream.ImportData	(		file_read,
			stream_filter
	)

导入流数据。

参数

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

返回

无。

SetData()

def fsdk.PDFStream.SetData	(		buffer,
			size
	)

设置流数据。

参数

[in]	buffer	一个内存块，表示要设置的新流数据。
[in]	size	参数buffer的大小，以字节为单位。

返回

无。