类 FSFileSpec 继承关系图:

构造函数
(BOOL)	- embed:
	嵌入由文件路径指定的文件的全部内容。更多...

(BOOL)	- embedWithPDFObject:
	（仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时，嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。更多...

(BOOL)	- embedWithStreamCallback:
	使用 FSFileStreamCallback 嵌入文件。更多...

(BOOL)	- exportToFile:
	将当前文件规范中表示的文件数据直接导出到文件中。更多...

(BOOL)	- exportToFileStream:
	通过流回调对象导出当前文件规范中表示的文件数据。更多...

(long long)	- getCompressedEmbeddedFileSize
	获取嵌入文件的压缩文件大小。更多...

(FSPDFDictionary *)	- getDict
	获取当前文件规范的PDF字典。更多...

(id< FSFileReaderCallback >)	- getFileData
	获取嵌入文件的文件数据。更多...

(long long)	- getFileSize
	获取嵌入文件的大小（未压缩文件大小）。更多...

(id)	- initWithDocument:
	构造函数。更多...

(id)	- initWithDocument:pdf_object:
	构造函数，从PDF文档中的现有文件规范PDF对象构造。更多...

(id)	- initWithOther:
	构造函数，使用另一个文件规范对象。更多...

(BOOL)	- isEmbedded
	检查当前文件规范对象是否表示嵌入文件。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

属性
FSAssociatedFilesRelationship	associteFileRelationship
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。

NSData *	checksum
	获取嵌入文件的校验和。更多...

FSDateTime *	creationDateTime
	获取关于嵌入文件创建时间的创建日期和时间。更多...

NSString *	description
	获取与当前文件规范关联的描述性文本。

NSString *	fileName
	获取文件名。

FSDateTime *	modifiedDateTime
	获取关于嵌入文件最后修改时间的修改日期和时间。更多...

NSString *	subtype
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取嵌入文件的"Subtype"键的MIME类型值。更多...

详细描述

PDF文件可以通过使用文件规范来引用另一个文件的内容。文件规范可以简单地表示另一个文件的文件路径，或表示另一个文件的全部内容，该内容被嵌入到当前PDF文件中。

函数文档

◆ embed:()

- (BOOL) embed: (NSString *) file_path

嵌入由文件路径指定的文件的全部内容。

当此函数成功时，指定文件的全部内容将被嵌入到当前文件规范所属的PDF文档中。

参数

[in] file_path 现有本地文件的完整路径。

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

◆ embedWithPDFObject:()

- (BOOL) embedWithPDFObject: (FSPDFObject*) pdf_object

（仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时，嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。

当此函数成功时，指定PDF流对象的全部内容将被嵌入到当前文件规范所属的PDF文档中。

参数

[in] pdf_object 一个有效的PDF对象。它应该是PDF流对象或引用PDF流对象的PDF引用对象。

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

◆ embedWithStreamCallback:()

- (BOOL) embedWithStreamCallback: (id<FSFileStreamCallback>) stream

使用 FSFileStreamCallback 嵌入文件。

当此函数成功时，请保持输入的流回调对象有效，直到PDF文件（当前文件规范所属的）被保存或关闭。

参数

[in] stream 用户实现的 FSFileStreamCallback 对象，用于读取文件内容。

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

◆ exportToFile:()

- (BOOL) exportToFile: (NSString *) path

将当前文件规范中表示的文件数据直接导出到文件中。

参数

[in] path 将保存数据的文件的完整路径。

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

◆ exportToFileStream:()

- (BOOL) exportToFileStream: (id<FSFileStreamCallback>) stream

通过流回调对象导出当前文件规范中表示的文件数据。

参数

[in] stream 用户实现的 FSFileStreamCallback 对象，用于保存文件数据。

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

◆ getCompressedEmbeddedFileSize()

- (long long) getCompressedEmbeddedFileSize

获取嵌入文件的压缩文件大小。

此函数仅在当前文件规范对象表示嵌入文件时有用。如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回: 嵌入文件的压缩文件大小。

◆ getDict()

- (FSPDFDictionary *) getDict

获取当前文件规范的PDF字典。

返回: PDF字典对象。如果有任何错误，此函数将返回nil。

◆ getFileData()

- (id< FSFileReaderCallback >) getFileData

获取嵌入文件的文件数据。

返回: 一个 FSFileReaderCallback 对象。用户可以调用 FSFileReaderCallback 类中的函数来读取文件数据。

◆ getFileSize()

- (long long) getFileSize

获取嵌入文件的大小（未压缩文件大小）。

此函数仅在当前文件规范对象表示嵌入文件时有用。如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回: 嵌入文件的文件大小（未压缩文件大小）。

◆ initWithDocument:()

- (id) initWithDocument: (FSPDFDoc*) document

构造函数。

此构造函数用于构造一个新的文件规范对象（不包含任何数据）。

参数

[in] document 一个有效的PDF文档对象，新的文件规范对象将属于该文档。

◆ initWithDocument:pdf_object:()

- (id) initWithDocument:	(FSPDFDoc*)	document
pdf_object:	(FSPDFObject*)	pdf_object

构造函数，从PDF文档中的现有文件规范PDF对象构造。

参数

[in]	document	一个有效的PDF文档对象，文件规范PDF对象属于该文档。
[in]	pdf_object	一个有效的PDF对象，表示PDF文档中的现有文件规范对象。它应该是字典对象或PDF引用对象：如果是PDF字典对象，它应该是文件规范字典。如果是PDF引用对象，它应该引用文件规范字典。此PDF对象可以从类型为 FSPDFNameTreeEmbeddedFiles 的 FSPDFNameTree 中检索。

◆ initWithOther:()

- (id) initWithOther: (FSFileSpec*) other

构造函数，使用另一个文件规范对象。

参数

[in] other 另一个文件规范对象。

◆ isEmbedded()

- (BOOL) isEmbedded

检查当前文件规范对象是否表示嵌入文件。

返回: YES表示当前文件规范对象表示嵌入文件。 NO表示当前文件规范对象不表示嵌入文件。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当当前对象为空时，意味着当前对象是无用的。

返回: YES表示当前对象为空，NO表示不为空。

属性说明

◆ checksum

- (NSData *) checksum

readwritenonatomicweak

获取嵌入文件的校验和。

此函数仅在当前文件规范对象表示嵌入文件时有用。 16字节字符串，是未压缩嵌入文件字节的校验和。校验和通过对嵌入文件流的字节应用标准MD5消息摘要算法来计算。
如果当前文件规范对象不表示嵌入文件，此函数将返回空字符串。

◆ creationDateTime

- (FSDateTime *) creationDateTime

readwritenonatomicweak

获取关于嵌入文件创建时间的创建日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。如果当前文件规范对象不表示嵌入文件，此函数将返回一个所有值都为0的日期和时间对象。

◆ modifiedDateTime

- (FSDateTime *) modifiedDateTime

readwritenonatomicweak

获取关于嵌入文件最后修改时间的修改日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。如果当前文件规范对象不表示嵌入文件，此函数将返回一个所有值都为0的日期和时间对象。

◆ subtype

- (NSString *) subtype

readwritenonatomicweak

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取嵌入文件的"Subtype"键的MIME类型值。

此函数仅在当前文件规范对象表示嵌入文件且用作关联文件时有用。