GetInterpretStatistics method

Applies to

Example

Description

This method returns interpretation statistics (both form statistics and character statistics) for a specific form definition from FORMS Interpret. The statistics include only a specific form definition in the job, which you specify using FormDefNo. The numbering of the form definitions in the job starts with 1.

See also GetInterpretCharacterStatistics, which returns character interpretation statistics for all the form definitions included in the job.

Syntax

[ReturnValue =] Object.GetInterpretStatistics (FormDefNo, TotalInterpretedCharacters, CertainCharacters, UnCertainCharacters, UnKnownCharacters, TotalInterpretedForms, CompleteForms, RetypeForms, IncompleteForms, ValidationErrorForms, InterpretErrorForms, MassVerifyForms, 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.

TotalInterpretedCharacters

Long (ByRef)

The total number of characters interpreted for this particular form definition.

CertainCharacters

Long (ByRef)

The total number of characters interpreted with a very high degree of certainty for this particular form definition.

UnCertainCharacters

Long (ByRef)

The total number of characters interpreted with a lower degree of certainty for this particular form definition.

UnKnownCharacters

Long (ByRef)

The total number of unknown characters for this particular form definition.

TotalInterpretedForms

Long (ByRef)

The total number of forms of this type interpreted.

CompleteForms

Long (ByRef)

The total number of processed forms of this type that got received Complete status.

RetypeForms

Long (ByRef)

The total number of forms of this type interpreted which received Retype status.

IncompleteForms

Long (ByRef)

The total number of forms of this type interpreted which received Incomplete status.

ValidationErrorForms

Long (ByRef)

The total number of forms of this type interpreted which received Validation error status.

InterpretErrorForms

Long (ByRef)

The total number of forms of this type interpreted which received Interpretation error status.

MassVerifyForms

Long (ByRef)

The total number of forms of this type interpreted which received Mass verify status.

NoOfAppendices

Long (ByRef)

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

Settings

1 <= FormDefNo <= Object.NoOfFormDefs

Return value

Data type: Integer – non-zero if the method failed to get the statistics and 0 if it succeeded. See Event return value constants.

Remarks

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

Classic method

GetItrpRefStat