Foxit PDF SDK
foxit::addon::compliance::PDFACompliance Class Reference
Inheritance diagram for foxit::addon::compliance::PDFACompliance:
foxit::Base

Public Types

enum  Version {
  e_VersionPDFA1a = 1, e_VersionPDFA1b = 2, e_VersionPDFA2a = 3, e_VersionPDFA2b = 4,
  e_VersionPDFA2u = 5, e_VersionPDFA3a = 6, e_VersionPDFA3b = 7, e_VersionPDFA3u = 8
}
 Enumeration for PDF/A version. More...
 

Public Member Functions

 PDFACompliance ()
 Constructor.
 
 PDFACompliance (const PDFACompliance &other)
 Constructor, with another PDFA compliance object. More...
 
 ~PDFACompliance ()
 Destructor.
 
ResultInformation ConvertPDFFile (const wchar_t *src_pdf_path, const wchar_t *saved_pdf_path, Version convert_to_version, ProgressCallback *progress_callback=0)
 Convert a PDF file with specified PDFA version. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const PDFACompliance &other) const
 Not equal operator. More...
 
PDFAComplianceoperator= (const PDFACompliance &other)
 Assign operator. More...
 
bool operator== (const PDFACompliance &other) const
 Equal operator. More...
 
ResultInformation Verify (Version verify_version, const wchar_t *src_pdf_path, int first_page_index=0, int last_page_index=-1, ProgressCallback *progress_callback=0)
 Verify a PDF file with specified PDFA version. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class can be used to verify if a PDF file matches a PDF/A version or convert a PDF file to a PDF/A version. Please ensure ComplianceEngine has been initialized successfully.

See also
ComplianceEngine

Member Enumeration Documentation

◆ Version

Enumeration for PDF/A version.

Values of this enumeration should be used alone.

Enumerator
e_VersionPDFA1a 

PDF/A-1a.

e_VersionPDFA1b 

PDF/A-1b.

e_VersionPDFA2a 

PDF/A-2a.

e_VersionPDFA2b 

PDF/A-2b.

e_VersionPDFA2u 

PDF/A-2u.

e_VersionPDFA3a 

PDF/A-3a.

e_VersionPDFA3b 

PDF/A-3b.

e_VersionPDFA3u 

PDF/A-3u.

Constructor & Destructor Documentation

◆ PDFACompliance()

foxit::addon::compliance::PDFACompliance::PDFACompliance ( const PDFACompliance other)

Constructor, with another PDFA compliance object.

Parameters
[in]otherAnother PDFA compliance object.

Member Function Documentation

◆ ConvertPDFFile()

ResultInformation foxit::addon::compliance::PDFACompliance::ConvertPDFFile ( const wchar_t *  src_pdf_path,
const wchar_t *  saved_pdf_path,
Version  convert_to_version,
ProgressCallback progress_callback = 0 
)

Convert a PDF file with specified PDFA version.

Parameters
[in]src_pdf_pathA complete path of source PDF file to be converted. This should not be an empty string.
[in]saved_pdf_pathA complete path for saving the converted PDF file. This should not be an empty string.
[in]convert_to_versionPDFA version to convert to.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be NULL. Default value: NULL.
Returns
A ResultInformation object.

◆ IsEmpty()

bool foxit::addon::compliance::PDFACompliance::IsEmpty ( ) const

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ operator!=()

bool foxit::addon::compliance::PDFACompliance::operator!= ( const PDFACompliance other) const

Not equal operator.

Parameters
[in]otherAnother PDFA compliance object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

PDFACompliance& foxit::addon::compliance::PDFACompliance::operator= ( const PDFACompliance other)

Assign operator.

Parameters
[in]otherAnother PDFA compliance object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::compliance::PDFACompliance::operator== ( const PDFACompliance other) const

Equal operator.

Parameters
[in]otherAnother PDFA compliance object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

◆ Verify()

ResultInformation foxit::addon::compliance::PDFACompliance::Verify ( Version  verify_version,
const wchar_t *  src_pdf_path,
int  first_page_index = 0,
int  last_page_index = -1,
ProgressCallback progress_callback = 0 
)

Verify a PDF file with specified PDFA version.

Parameters
[in]verify_versionPDFA version to verify.
[in]src_pdf_pathA complete path of source PDF file to be verified. This should not be an empty string.
[in]first_page_indexIndex of the first page to be verified, staring from 0. Default value: 0.
[in]last_page_indexIndex of the last page to be verified. If this is -1, that means all the pages of the source PDF file will be verified and parameter first_page_index would be ignored. Default value: -1.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be NULL. Default value: NULL.
Returns
A ResultInformation object.