Document.DocumentNumber property

Read-Write property. This is writable only at the ScanError event when the document could not be identified by ScanTools, and your solution allows for entering the correct document number.

For successfully scanned documents, it is 1-based ordinal of the document definition within the application definition. This number is also the same as the one written to the NCS Header within the output record as a 3-byte ASCII string. For example, document number 1 is written as 001.

NOTE: As a best practice, ensure that Document.DocumentNumber is > 0 before accessing other members of the Document interface. This is especially important at the ScanError event.

The only time you write to this property is to programmatically identify an unscannable document. What constitutes an unscannable document is solution specific. Typically, you should ask the operator to retry scanning the sheet a few times before deeming it unscannable. ScanTools considers one or more of the following conditions as unscannable:

• Unknown form id marks
• Timing marks were not found
• Sheet was skewed

The following are not opportunities for specifying the document number programmatically:

• A hardware problem on the scanner – jam
• Other system errors

You should set this property only for the first sheet of a document that was not identified correctly by ScanTools and you want to treat it as unscannable. Be sure to set a value in the range 1 to number-of-documents per the application definition. If the document has a litho-code, then you must also write the Document.Lithocode property.

For a sheet that is deemed unscannable and is not the first sheet in the document, the document is already identified and the DocumentNumber property will report the correct value. There is no need to write to the DocumentNumber or Lithocode properties.

For the first sheet, call ScanningManager.SetScanErrorResolution with a parameter of L_SCANERROR_RESOLUTION_IGNORE_ERROR to make your document identification effective. The second sheet error resolution should be L_SCANERROR_RESOLUTION_RESUME.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations.

IDL

propget, HRESULT DocumentNumber([out, retval] long* pVal);

propput, HRESULT DocumentNumber([in] LONG DocumentNumber);

Values

Exceptions

While writing:

• Document number is invalid; greater than the number of documents in the application definition or less than 1
• Document is already identified

Scanning Services Exceptions