Public 成员函数
	FileSpec (document)
	构造函数。更多...

	FileSpec (document, pdf_object)
	从PDF文档中现有的文件规范PDF对象构造的构造函数。更多...

	Embed (file_path)
	嵌入由文件路径指定的文件的全部内容。更多...

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

	Embed (stream)
	使用 FSDK.StreamCallback 嵌入文件。更多...

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

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

	GetAssociteFileRelationship ()
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。更多...

	GetChecksum ()
	获取嵌入文件的校验和。更多...

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

	GetCreationDateTime ()
	获取嵌入文件创建时的创建日期和时间。更多...

	GetDescription ()
	获取与当前文件规范关联的描述性文本。更多...

	GetDict ()
	获取当前文件规范的PDF字典。更多...

	GetFileData ()
	获取嵌入文件的文件数据。更多...

	GetFileName ()
	获取文件名。更多...

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

	GetModifiedDateTime ()
	获取嵌入文件上次修改时的修改日期和时间。更多...

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

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

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

	SetAssociteFileRelationship (associfile_relationship)
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。更多...

	SetChecksum (checksum)
	为嵌入文件设置校验和。（不影响本地文件）更多...

	SetCreationDateTime (date_time)
	为嵌入文件设置创建日期和时间。（不影响本地文件）更多...

	SetDescription (description)
	设置与当前文件规范关联的描述性文本。更多...

	SetFileName (file_name)
	设置文件名。更多...

	SetModifiedDateTime (date_time)
	为嵌入文件设置上次修改日期和时间。（不影响本地文件）更多...

	SetSubtype (subtype)
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件）更多...

详细描述

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

构造及析构函数说明

◆ FileSpec() [1/2]

FSDK::FileSpec::FileSpec ( document )

构造函数。

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

参数

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

◆ FileSpec() [2/2]

FSDK::FileSpec::FileSpec	(	document	,
		pdf_object
	)

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

参数

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

成员函数说明

◆ Embed() [1/3]

FSDK::FileSpec::Embed ( file_path )

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

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

参数

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

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

◆ Embed() [2/3]

FSDK::FileSpec::Embed ( pdf_object )

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

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

参数

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

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

◆ Embed() [3/3]

FSDK::FileSpec::Embed ( stream )

使用 FSDK.StreamCallback 嵌入文件。

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

参数

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

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

◆ ExportToFile()

FSDK::FileSpec::ExportToFile ( path )

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

参数

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

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

◆ ExportToFileStream()

FSDK::FileSpec::ExportToFileStream ( stream )

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

参数

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

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

◆ GetAssociteFileRelationship()

FSDK::FileSpec::GetAssociteFileRelationship ( )

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

返回: 关联文件关系。请参考从 FSDK.AssociatedFiles.e_RelationshipSource 开始的值，应为这些值之一。

◆ GetChecksum()

FSDK::FileSpec::GetChecksum ( )

获取嵌入文件的校验和。

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

返回: 校验和字符串。

◆ GetCompressedEmbeddedFileSize()

FSDK::FileSpec::GetCompressedEmbeddedFileSize ( )

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

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

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

◆ GetCreationDateTime()

FSDK::FileSpec::GetCreationDateTime ( )

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

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

返回: 嵌入文件的创建日期时间。

◆ GetDescription()

FSDK::FileSpec::GetDescription ( )

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

返回: 描述性文本。

◆ GetDict()

FSDK::FileSpec::GetDict ( )

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

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

◆ GetFileData()

FSDK::FileSpec::GetFileData ( )

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

返回: FSDK.FileReaderCallback 对象。用户可以调用类 FSDK.FileReaderCallback 中的函数来读取文件数据。

◆ GetFileName()

FSDK::FileSpec::GetFileName ( )

获取文件名。

返回: 文件名。如果找不到文件名，此函数将返回空字符串。

◆ GetFileSize()

FSDK::FileSpec::GetFileSize ( )

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

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

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

◆ GetModifiedDateTime()

FSDK::FileSpec::GetModifiedDateTime ( )

获取嵌入文件上次修改时的修改日期和时间。

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

返回: 嵌入文件的修改日期时间。

◆ GetSubtype()

FSDK::FileSpec::GetSubtype ( )

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

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

返回: 子类型字符串。

◆ IsEmbedded()

FSDK::FileSpec::IsEmbedded ( )

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

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

◆ IsEmpty()

FSDK::FileSpec::IsEmpty ( )

检查当前对象是否为空。

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

返回: true 表示当前对象为空，而 false 表示不为空。

◆ SetAssociteFileRelationship()

FSDK::FileSpec::SetAssociteFileRelationship ( associfile_relationship )

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。

此函数对于新创建的关联文件规范对象是必需的。

参数

[in] associfile_relationship 要设置的关联文件关系。请参考从 FSDK.AssociatedFiles.e_RelationshipSource 开始的值，应为这些值之一。

返回: 无。

◆ SetChecksum()

FSDK::FileSpec::SetChecksum ( checksum )

为嵌入文件设置校验和。（不影响本地文件）

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

参数

[in] checksum 要设置的校验和。

返回: 无。

◆ SetCreationDateTime()

FSDK::FileSpec::SetCreationDateTime ( date_time )

为嵌入文件设置创建日期和时间。（不影响本地文件）

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

参数

[in] date_time 要设置的创建日期和时间。

返回: 无。

◆ SetDescription()

FSDK::FileSpec::SetDescription ( description )

设置与当前文件规范关联的描述性文本。

参数

[in] description 要设置的描述性文本。它不应为空字符串。

返回: 无。

◆ SetFileName()

FSDK::FileSpec::SetFileName ( file_name )

设置文件名。

此函数对于新文件规范对象（不是从现有文件规范PDF对象构造的）是必需的。

参数

[in] file_name 要设置的文件名。它不应为空字符串。

返回: 无。

◆ SetModifiedDateTime()

FSDK::FileSpec::SetModifiedDateTime ( date_time )

为嵌入文件设置上次修改日期和时间。（不影响本地文件）

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

参数

[in] date_time 要设置的上次修改日期和时间。

返回: 无。

◆ SetSubtype()

FSDK::FileSpec::SetSubtype ( subtype )

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件）

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

参数

[in] subtype 有效的MIME类型值。默认值："application/octet-stream"。

返回: 无。

Public 成员函数

详细描述

构造及析构函数说明

◆ FileSpec() [1/2]

◆ FileSpec() [2/2]

成员函数说明

◆ Embed() [1/3]

◆ Embed() [2/3]

◆ Embed() [3/3]

◆ ExportToFile()

◆ ExportToFileStream()

◆ GetAssociteFileRelationship()

◆ GetChecksum()

◆ GetCompressedEmbeddedFileSize()

◆ GetCreationDateTime()

◆ GetDescription()

◆ GetDict()

◆ GetFileData()

◆ GetFileName()

◆ GetFileSize()

◆ GetModifiedDateTime()

◆ GetSubtype()

◆ IsEmbedded()

◆ IsEmpty()

◆ SetAssociteFileRelationship()

◆ SetChecksum()

◆ SetCreationDateTime()

◆ SetDescription()

◆ SetFileName()

◆ SetModifiedDateTime()

◆ SetSubtype()