AnalyseFile

Document properties

Description

Analyses a file on disk. The entire file is not loaded into memory so huge files can be examined. Use the GetAnalysisInfo function to retrieve the individual analysis results. Call DeleteAnalysis to remove the results from memory when you are finished.

Syntax

Delphi

function TDebenuPDFLibrary1811.AnalyseFile(InputFileName, 
  Password: WideString): Integer;

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::AnalyseFile(InputFileName As String,
  Password As String) As Long

DLL

int DPLAnalyseFile(int InstanceID, wchar_t * InputFileName, wchar_t * Password)

Parameters

InputFileName	The path and name of the file to analyse.
Password	The password to use when opening the file. This can be either the owner or the user password. This parameter can be left blank if the file does not require a password to be opened.

Return values

0	The file could not be analysed. Check the result of the LastErrorCode function to determine the reason for the failure.
Non-zero	The analysis results ID. Pass this to the GetAnalysisInfo function.