Go to the documentation of this file.
15 #ifndef FS_FILESPEC_H_
16 #define FS_FILESPEC_H_
188 bool Embed(
const wchar_t* file_path);
362 #endif // FS_FILESPEC_H_
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
AssociatedFiles::Relationship GetAssociteFileRelationship() const
(Only supported in PDF 2.0) Get the associated file relationship when current file specification is u...
DateTime GetModifiedDateTime() const
Get modified date and time about when the embedded file was last modified.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
bool ExportToFileStream(foxit::common::file::StreamCallback *stream) const
Export the file data that represented in current file specification through a stream callback object.
Definition: fs_filespec.h:38
Definition: fs_basictypes.h:460
void SetFileName(const wchar_t *file_name)
Set the file name.
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current file specification.
String GetSubtype() const
(Only support in PDF 2.0) Get the MIME type value for "Subtype" key for embedded file when current fi...
common::file::ReaderCallback * GetFileData() const
Get the file data of embedded file.
File stream interface, reading & writing.
Definition: fx_stream.h:675
FileSpec(const PDFDoc &document)
Constructor.
int64 GetCompressedEmbeddedFileSize() const
Get the compressed file size of embedded file.
Header file for common definitions and classes.
File reading interface.
Definition: fx_stream.h:570
Relationship
Enumeration for the relationship between PDF document and the associated file.
Definition: fs_pdfassociatefiles.h:60
Header file for file operation related definitions and functions.
void SetAssociteFileRelationship(AssociatedFiles::Relationship associfile_relationship)
(Only supported in PDF 2.0) Set the associated file relationship when current file specification is u...
Header file for associated file related definitions and classes.
Definition: fs_pdfobject.h:55
bool IsEmpty() const
Check whether current object is empty or not.
void SetSubtype(const String &subtype="application/octet-stream")
(Only support in PDF 2.0) Set the MIME type value for "Subtype" key for embedded file (Not affect loc...
bool operator!=(const FileSpec &other) const
Not equal operator.
BYTE STRING CLASS.
Definition: fx_string.h:317
void SetModifiedDateTime(const DateTime &date_time)
Set last modified date and time for the embedded file. (Not affect local file)
bool Embed(const wchar_t *file_path)
Embed the whole content of a file which is specified by file path.
DateTime GetCreationDateTime() const
Get creation date and time about when the embedded file was created.
Header file for PDF object related definitions and classes.
bool operator==(const FileSpec &other) const
Equal operator.
WString GetFileName() const
Get the file name.
Foxit namespace.
Definition: fs_taggedpdf.h:27
bool IsEmbedded() const
Check whether current file specification object represents an embedded file or not.
int64 GetFileSize() const
Get the size of embedded file (uncompressed file size).
void SetCreationDateTime(const DateTime &date_time)
Set the creation date and time for the embedded file. (Not affect local file)
Definition: fs_pdfobject.h:809
String GetChecksum() const
Get the checksum for embedded file.
FileSpec & operator=(const FileSpec &other)
Assign operator.
#define NULL
The null-pointer value.
Definition: fx_system.h:780
Definition: fs_pdfdoc.h:610
void SetDescription(const String &description)
Set the descriptive text associated with current file specification.
bool ExportToFile(const wchar_t *path) const
Export the file data that represented in current file specification directly into a file.
WIDE STRING CLASS.
Definition: fx_string.h:1452
Definition: fs_basictypes.h:427
void SetChecksum(const String &checksum)
Set the checksum for embedded file. (Not affect local file)
String GetDescription() const
Get the descriptive text associated with current file specification.
@2024 Foxit Software Incorporated. All rights reserved.