PoDoFo::PdfFileSpec Class Reference

A file specification is used in the PDF file to refer to another file. More...

#include <PdfFileSpec.h>

Inherits PoDoFo::PdfDictionaryElement.

Public Member Functions
bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< PdfFileSpec > &filespec)
nullable< const PdfString & >	GetFilename () const
	Gets file name for the FileSpec.
void	SetFilename (nullable< const PdfString & > filename)
void	SetEmbeddedData (nullable< const charbuff & > data)
void	SetEmbeddedDataFromFile (const std::string_view &filepath)
nullable< charbuff >	GetEmbeddedData () const

Friends
class	PdfDocument
class	PdfAnnotationFileAttachment
class	PdfNameTreeBase

Detailed Description

A file specification is used in the PDF file to refer to another file.

The other file can be a file outside of the PDF or can be embedded into the PDF file itself.

Member Function Documentation

GetFilename()

nullable< const PdfString & > PdfFileSpec::GetFilename

(

)

const

Gets file name for the FileSpec.

Returns

the filename of this file specification

---

The documentation for this class was generated from the following files:

• src/podofo/main/PdfFileSpec.h
• src/podofo/main/PdfFileSpec.cpp