GetScanStatistics method

Applies to

Example

Description

Gets the Scan statistics for a specific form definition.

Syntax

[ReturnValue =] Object.GetScanStatistics (FormDefNo, ScannedForms, NoOfAppendices)

Part

Data type

Description

Object

Object

An object expression that evaluates to an object in the Applies To list.

FormDefNo

Integer

The number representing the form definition in the job from which statistics are gotten.

ScannedForms

Long (ByRef)

The total number of processed forms for this particular form definition.

NoOfAppendices

Long (ByRef)

The total number of appendices processed for this type of form.

Settings

1 <= FormDefNo <= Object.NoOfFormDefs

Return value

Data type: Integer – 0 if it succeeded, otherwise non-zero. See Event return value constants.

Remarks

If this method is used while running a job, the result is a snapshot. Use this method in the JobStopped event to get the total statistics for the entire job session.

Classic method

GetScanRefStat