Foxit PDF SDK
fsdk.CompareResults Class Reference

Public Member Functions

def Clear ()
 Clear all the result information.
More...
 
def GetBase_doc_results ()
 Get a result information array, which contains all the compared results of a PDF page (which has been compared) in the base document. More...
 
def GetCompared_doc_results ()
 Get a result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document. More...
 
def SetBase_doc_results (value)
 Set a result information array, which contains all the compared results of a PDF page (which has been compared) in the base document. More...
 
def SetCompared_doc_results (value)
 Set a result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document. More...
 

Detailed Description

This class contains all the results of a comparison process, including the results in both base document and compared document. This class is used as the return type of function fsdk.Comparison.DoCompare .

See also
Comparison .

Member Function Documentation

◆ Clear()

def fsdk.CompareResults.Clear ( )

Clear all the result information.

Returns
None.

◆ GetBase_doc_results()

fsdk.CompareResults.GetBase_doc_results ( )

Get a result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.

Returns
A result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.

◆ GetCompared_doc_results()

fsdk.CompareResults.GetCompared_doc_results ( )

Get a result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.

Returns
A result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.

◆ SetBase_doc_results()

fsdk.CompareResults.SetBase_doc_results (   value)

Set a result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.

Parameters
[in]valueA result information array, which contains all the compared results of a PDF page (which has been compared) in the base document.
Returns
None.

◆ SetCompared_doc_results()

fsdk.CompareResults.SetCompared_doc_results (   value)

Set a result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.

Parameters
[in]valueA result information array, which contains all the compared results of a PDF page (which has been compared) in the compared document.
Returns
None.