PDFix SDK  7.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
PdfAlternate Struct Referenceabstract
Pdf Layer

PdfAlternate class. More...

#include <pdfix.h>

Inheritance diagram for PdfAlternate:
PdfHtmlAlternate

Public Member Functions

virtual PdfAlternateType GetSubtype () const =0
 Gets the subtype of the PDF alternate. More...
 
virtual int GetName (wchar_t *buffer, int len) const =0
 Gets a buffer containing the name of an alternate, otherwise it returns 0. More...
 
virtual int GetDescription (wchar_t *buffer, int len) const =0
 Gets a buffer containing the description of an alternate, otherwise it returns 0. More...
 
virtual int GetFileName (wchar_t *buffer, int len) const =0
 Gets a buffer containing the file name of the main alternate file. More...
 
virtual bool SaveContent (const wchar_t *path)=0
 
virtual int Release ()=0
 Closes the PDF alternate and release any loaded content. More...
 

Detailed Description

PdfAlternate class.

PdfAlternate class.

Member Function Documentation

◆ GetDescription()

virtual int PdfAlternate::GetDescription ( wchar_t *  buffer,
int  len 
) const
pure virtual

Gets a buffer containing the description of an alternate, otherwise it returns 0.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetFileName()

virtual int PdfAlternate::GetFileName ( wchar_t *  buffer,
int  len 
) const
pure virtual

Gets a buffer containing the file name of the main alternate file.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetName()

virtual int PdfAlternate::GetName ( wchar_t *  buffer,
int  len 
) const
pure virtual

Gets a buffer containing the name of an alternate, otherwise it returns 0.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetSubtype()

virtual PdfAlternateType PdfAlternate::GetSubtype ( ) const
pure virtual

Gets the subtype of the PDF alternate.

Returns
the PDF alternate subtype

◆ Release()

virtual int PdfAlternate::Release ( )
pure virtual

Closes the PDF alternate and release any loaded content.

Returns
the number of remaining references to the object
See also
PdfDoc::AcquireAlternate

◆ SaveContent()

virtual bool PdfAlternate::SaveContent ( const wchar_t *  path)
pure virtual

Saves the alternate content to the folder specified by path and fileSys. The path is a base path and saved content cause creation of additional subfolders based on the relative path specified in the embedded file spec.

Returns
True if the content was saved successfully
See also
PdfAlternate::GetFileName
PdfAlternate::Release