PoDoFo::PdfFileSpec Class Reference

#include <PdfFileSpec.h>

Inheritance diagram for PoDoFo::PdfFileSpec:

Public Member Functions
	PdfFileSpec (const char *pszFilename, const unsigned char *data, ptrdiff_t size, PdfVecObjects *pParent, bool bStripPath=false)
const PdfString &	GetFilename (bool canUnicode) const
Public Member Functions inherited from PoDoFo::PdfElement
PdfObject *	GetObject ()
const PdfObject *	GetObject () const

Additional Inherited Members
Protected Member Functions inherited from PoDoFo::PdfElement
	PdfElement (const char *pszType, PdfVecObjects *pParent)
	PdfElement (const char *pszType, PdfDocument *pParent)
	PdfElement (const char *pszType, PdfObject *pObject)
	PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject)
const char *	TypeNameForIndex (int i, const char **ppTypes, long lLen) const
int	TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const
PdfObject *	CreateObject (const char *pszType=NULL)
PdfObject *	GetNonConstObject () const

Detailed Description

A file specification is used in the PDF file to referr to another file. The other file can be a file outside of the PDF or can be embedded into the PDF file itself.

Constructor & Destructor Documentation

PdfFileSpec()

PoDoFo::PdfFileSpec::PdfFileSpec	(	const char *	pszFilename,
		const unsigned char *	data,
		ptrdiff_t	size,
		PdfVecObjects *	pParent,
		bool	bStripPath = false
	)

Embeds the file in memory from "data" buffer under "pszFileName" fie name.

Member Function Documentation

GetFilename()

const PdfString & PoDoFo::PdfFileSpec::GetFilename

(

bool

canUnicode

)

const

Gets file name for the FileSpec

Parameters

canUnicode

Whether can return file name in unicode (/UF)

Returns

the filename of this file specification. if no general name is available it will try the Unix, Mac and DOS keys too.