CheckImageFormat Property

A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData properties.

Syntax

 check21.getCheckImageFormat(index, [callback])
 check21.setCheckImageFormat(index,  checkImageFormat, [callback])

Possible Values

  0 (ifTIFF), 
  1 (ifIOCA), 
  20 (ifPNG), 
  21 (ifJFIF), 
  22 (ifSPIFF), 
  23 (ifJBIG), 
  24 (ifJPEG2000)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCheckImageFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCheckImageFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

A code that identifies the type of image format used for the images contained in the CheckFrontImageData and CheckBackImageData properties. Values 0-19 may e used without a pre-existing agreement. Values 20-99 shall only be used when an agreement exists indicating that the sender and receiver both support the specified image format type and the type is specified below or on the X9 web site. The image format type is also commonly specified by reference to the file extension used when the CheckFrontImageData or CheckBackImageData is saved as an image file. The file extension for each image format is included below for reference.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer