Poppler CPP 24.11.0
Public Member Functions | List of all members
poppler::embedded_file Class Reference

#include "poppler/cpp/poppler-embedded-file.h"

Inheritance diagram for poppler::embedded_file:
Inheritance graph
[legend]

Public Member Functions

 ~embedded_file ()
 
byte_array checksum () const
 
time_type creation_date () const
 
time_t creation_date_t () const
 
byte_array data () const
 
ustring description () const
 
bool is_valid () const
 
std::string mime_type () const
 
time_type modification_date () const
 
time_t modification_date_t () const
 
std::string name () const
 
int size () const
 

Detailed Description

Represents a file embedded in a PDF document.

Constructor & Destructor Documentation

◆ ~embedded_file()

embedded_file::~embedded_file ( )

Destroys the embedded file.

Member Function Documentation

◆ checksum()

byte_array embedded_file::checksum ( ) const
Returns
the checksum of the embedded file

◆ creation_date()

time_type embedded_file::creation_date ( ) const
Returns
the time_type representing the creation date of the embedded file, if available

◆ creation_date_t()

time_t embedded_file::creation_date_t ( ) const
Returns
the time_t representing the creation date of the embedded file, if available

◆ data()

byte_array embedded_file::data ( ) const

Reads all the data of the embedded file.

Returns
the data of the embedded file

◆ description()

ustring embedded_file::description ( ) const
Returns
the description of the embedded file

◆ is_valid()

bool embedded_file::is_valid ( ) const
Returns
whether the embedded file is valid

◆ mime_type()

std::string embedded_file::mime_type ( ) const
Returns
the MIME type of the embedded file, if available

◆ modification_date()

time_type embedded_file::modification_date ( ) const
Returns
the time_type representing the modification date of the embedded file, if available

◆ modification_date_t()

time_t embedded_file::modification_date_t ( ) const
Returns
the time_t representing the modification date of the embedded file, if available

◆ name()

std::string embedded_file::name ( ) const
Returns
the name of the embedded file

◆ size()

int embedded_file::size ( ) const
Note
this is not always available in the PDF document, in that case this will return -1.
Returns
the size of the embedded file, if known