AnalyseFileA

Document properties

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to AnalyseFile and string arguments are interpreted using the current SetAnsiMode code page

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 DLAnalyseFileA(InstanceID: Integer; InputFileName, Password: PAnsiChar): Integer;

DLL

int DLAnalyseFileA(int InstanceID, const char * InputFileName, const char * Password);

Parameters

InputFileNameThe path and name of the file to analyse.
PasswordThe 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

0The file could not be analysed. Check the result of the LastErrorCode
Non-zeroThe analysis results ID. Pass this to the GetAnalysisInfo function.