PdsFileSpec Struct Reference

PdsFileSpec class. More...

#include <pdfix.h>

Public Member Functions
virtual PdsDictionary *	GetDictionary () const =0
	Retrieves the dictionary object associated with this file specification.
virtual int	GetFileName (wchar_t *buffer, int len)=0
	Gets the file name of the file associated with this FileSpec.
virtual bool	SetFileName (const wchar_t *buffer)=0
	Sets the file name for the embedded or associated file.
virtual PdsStream *	GetFileStm ()=0
	Retrieves the data stream object representing the embedded file.

Detailed Description

PdsFileSpec class.

The PdsFileSpec object represents a file specification in a PDF document. It is used to describe and reference files that are embedded within the PDF, linked externally, or associated with document content. File specifications enable PDFs to include attachments, associate data (such as source files or alternate representations), or reference external resources.

Member Function Documentation

GetDictionary()

virtual PdsDictionary * PdsFileSpec::GetDictionary ( ) const

pure virtual

Retrieves the dictionary object associated with this file specification.

Returns

The PdsDictionary representing the internal dictionary of the FileSpec object, or null if not available.

GetFileName()

virtual int PdsFileSpec::GetFileName ( wchar_t * buffer, int len )

pure virtual

Gets the file name of the file associated with this FileSpec.

Parameters

buffer	(filled by method) If null, the function returns the required buffer length (in wchar_t units).
len	The size of the buffer provided.

Returns

true if successful; false otherwise.

GetFileStm()

virtual PdsStream * PdsFileSpec::GetFileStm ( )

pure virtual

Retrieves the data stream object representing the embedded file.

Returns

A pointer to the PdsStream representing the embedded file content, or null if not embedded.

SetFileName()

virtual bool PdsFileSpec::SetFileName ( const wchar_t * buffer )

pure virtual

Sets the file name for the embedded or associated file.

Parameters

buffer

The wide-character string specifying the file name to set.

Returns

true if successful; false otherwise.