Image Generator SDK  4.23.0
The Image Generator SDK provides a library to generate QR codes and CrontoSign images
ImageGeneratorSDK Class Reference

The Image Generator SDK main class. It can generate a QR code or a CrontoSign image. More...

Static Public Member Functions

static CrontoImageResponse GenerateCrontoSign (int squareSize, string inputValue)
 Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image. The output image is to be printed on paper. More...
 
static CrontoImageResponse GenerateCrontoSign (int squareSize, string inputValue, bool onPaper)
 Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image. More...
 
static CrontoImageResponse GenerateDynamicCrontoImage (int squareSize, string inputValue, bool onPaper)
 Generates a CRONTO image for the corresponding input values. The size of the image is dynamic and depends on the inputValue length. CAUTION: The CRONTO images generated with this method cannot be scanned by VASCO hardware authenticators (e.g. DP760, DP780). /// More...
 
static BWQRCodeResponse GenerateBWQRCode (int imageSize, string inputValue, int errorCorrectionLevel)
 Generates a black and white QR code image More...
 

Static Public Attributes

const string VERSION = "4.23.0"
 Version of the Image Generator SDK More...
 

Detailed Description

The Image Generator SDK main class. It can generate a QR code or a CrontoSign image.

Member Function Documentation

◆ GenerateBWQRCode()

static BWQRCodeResponse GenerateBWQRCode ( int  imageSize,
string  inputValue,
int  errorCorrectionLevel 
)
static

Generates a black and white QR code image

Parameters
imageSizeThe side length of the generated image. The minimum square size is ImageGeneratorSDKConstants.QRCODE_MIN_IMAGE_SIZE, and the maximum square size is ImageGeneratorSDKConstants.QRCODE_MAX_IMAGE_SIZE
inputValueString to encode. Supports numeric, alphanumeric, ISO 8859-1 and Shift JIS X 0208 formats
errorCorrectionLevelThe error correction level (which is QRCODE_ERROR_CORRECTION_LEVEL_LOW, QRCODE_ERROR_CORRECTION_LEVEL_LOW, QRCODE_ERROR_CORRECTION_LEVEL_LOW or QRCODE_ERROR_CORRECTION_LEVEL_LOW)
Returns
A BWQRCodeResponse object containing the QR code image and the associated boolean matrix
Exceptions
ImageGeneratorSDKException

Vasco.Image.Exceptions.ImageGeneratorSDKErrorCodes.INPUT_VALUE_EMPTY if the input value is empty Vasco.Image.Exceptions.ImageGeneratorSDKErrorCodes.INPUT_VALUE_TOO_LONG if the input value is too long Vasco.Image.Exceptions.ImageGeneratorSDKErrorCodes.QRCODE_IMAGE_SIZE_INVALID_VALUE if the image size is invalid Vasco.Image.Exceptions.ImageGeneratorSDKErrorCodes.QRCODE_ERROR_CORRECTION_LEVEL_INVALID_VALUE if the error correction level is invalid Vasco.Image.Exceptions.ImageGeneratorSDKErrorCodes.INTERNAL_ERROR if an internal error is raised

◆ GenerateCrontoSign() [1/2]

static CrontoImageResponse GenerateCrontoSign ( int  squareSize,
string  inputValue 
)
static

Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image. The output image is to be printed on paper.

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
Vasco.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

◆ GenerateCrontoSign() [2/2]

static CrontoImageResponse GenerateCrontoSign ( int  squareSize,
string  inputValue,
bool  onPaper 
)
static

Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image.

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
onPaperTrue if and only if the image is to be printed on paper
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
Vasco.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

◆ GenerateDynamicCrontoImage()

static CrontoImageResponse GenerateDynamicCrontoImage ( int  squareSize,
string  inputValue,
bool  onPaper 
)
static

Generates a CRONTO image for the corresponding input values. The size of the image is dynamic and depends on the inputValue length. CAUTION: The CRONTO images generated with this method cannot be scanned by VASCO hardware authenticators (e.g. DP760, DP780). ///

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is ImageGeneratorSDKConstants.CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
onPaperTrue if and only if the image is to be printed on paper
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
Vasco.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

Field Documentation

◆ VERSION

const string VERSION = "4.23.0"
static

Version of the Image Generator SDK


The documentation for this class was generated from the following file: