Image formats supported by the encoder.

  enum ImageTypeEnum {
      IMAGE_PNG== 0,
      IMAGE_SVG== 1,
      IMAGE_EMF== 2,
      IMAGE_EPS== 3,
      IMAGE_BMP== 4
  };

Remarks

The ImageTypeEnum enum has the following values:

PNG and BMP are raster formats, which store color information of individual pixels. SVG, EMF and EPS are vector graphics formats and contains drawing commands instead. If you are using raster graphic format, one pixel should be mapped to one or integral times pixels on the printer. If you are using vector graphics format, the drawing units should map to integral times pixels on the printer.

The QRCodeEncode function encodes data and returns a pointer that points to encoder result object.

  int __stdcall  QRCodeEncode(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel,
      void ** ppResult
  );

Parameters

Return Values

If the function succeeded, the return value is 0. If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

This function encodes the data according to the parameter specified, and returns a pointer from which you can retrieve the encoding result.

The function QRCodeEncode2 is an abbreviated version of QRCodeEncode.

  void *__stdcall    QRCodeEncode2(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel
  );

Parameters

Return Values

If the function failed, the return value is 0 (NULL). If it succeeds, it returns a pointer that points to the result object. You should release the encoder result object by calling function DestroyQRCodeEncodeResult.

Remarks

In this function, a pointer is returned instead of status code. A non-null return value indicates that no error occurred. The pointer associated resource must be released by calling DestroyQRCodeEncodeResult.

The function QRCodeEncode2W is used to encode unicode strings into QR Code in a way compliant with ZXing reader.

  void *__stdcall    QRCodeEncode2W(
      const wchar_t * dataToEncode,
      int versionRequested,
      int ecLevel
  );

Parameters

Return Values

If the function failed, the return value is 0 (NULL). If it succeeds, it returns a pointer that points to the result object. You should release the encoder result object by calling function DestroyQRCodeEncodeResult.

Remarks

Read Section 2.2.7, “Unicode String Support” for more information. QR Code does not natively support unicode. Use of this feature require special support of a reader.

The MicroQRCodeEncode function encodes data in Micro QR Code and returns a pointer that points to encoder result object.

  int __stdcall  MicroQRCodeEncode(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel,
      void ** ppResult
  );

Parameters

Return Values

If the function succeeded, the return value is 0. If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

This function encodes the data according to the parameter specified, and returns a pointer from which you can retrieve the encoding result.

The function MicroQRCodeEncode2 is an abbreviated version of MicroQRCodeEncode.

  void *__stdcall    MicroQRCodeEncode2(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel
  );

Parameters

Return Values

If the function failed, the return value is 0 (NULL). If it succeeds, it returns a pointer that points to the result object. You should release the encoder result object by calling function DestroyQRCodeEncodeResult.

Remarks

In this function, a pointer is returned instead of status code. A non-null return value indicates that no error occurred. The pointer associated resource must be released by calling DestroyQRCodeEncodeResult.

The HIBC_QRCodeEncode function encodes data and returns a pointer that points to encoder result object.

  int __stdcall  HIBC_QRCodeEncode(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel,
      void ** ppResult
  );

Parameters

Return Values

If the function succeeded, the return value is 0. If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

This function encodes the data according to the parameter specified, and returns a pointer from which you can retrieve the encoding result.

The function HIBC_QRCodeEncode2 is an abbreviated version of QRCodeEncode.

  void *__stdcall    HIBC_QRCodeEncode2(
      const char * dataToEncode,
      int versionRequested,
      int ecLevel
  );

Parameters

Return Values

If the function failed, the return value is 0 (NULL). If it succeeds, it returns a pointer that points to the result object. You should release the encoder result object by calling function DestroyQRCodeEncodeResult.

Remarks

In this function, a pointer is returned instead of status code. A non-null return value indicates that no error occurred. The pointer associated resource must be released by calling DestroyQRCodeEncodeResult.

The QRCodeResultGetSizeID function retrieves the size ID of the QRCode barcode created.

  int __stdcall  QRCodeResultGetVersion(
      void * pEncodeResult
  );

Parameters

Return Values

The actual version of the barcode.

The QRCodeResultGetBarcodeString function retrieves the barcode string that becomes a QRCode symbol after being formatted with a QRCode font.

  int __stdcall  QRCodeResultGetBarcodeString(
      void * pEncodeResult,
      char * buffer,
      unsigned int * maxSize,
      const char * eol
  );

Parameters

Return Values

If the function succeeded, it returns the length of the string (excluding terminating NUL character). If the function fails due to insufficient storage, it returns 0.

Remarks

When creating barcodes using font-based solution, you first call encoder function QRCodeEncode or QRCodeEncode2 to obtain a pointer that points to the result object. Then QRCodeResultGetBarcodeString is called to obtain a string that becomes QRCode symbol after the font is applied. If memory is not an issue, allocate a large buffer with 8096 bytes to hold the largest QRCode barcode. This size is sufficient for the largest symbol with carriage return and line feed as line ending.

The DestroyQRCodeEncodeResult function releases all resources allocated to the encoder result object.

  void __stdcall DestroyQRCodeEncodeResult(
      void * pResult
  );

Parameters

Remarks

After the object is destroyed, the specific pointer pResult is no longer valid.

The PaintQRCodeImageRaster function writes the QRCode barcode in raster image format specified to a disk file.

  int __stdcall  PaintQRCodeImageRaster(
      void * pEncodeResult,
      const wchar_t * wszFilename,
      int pixelsPerModule,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

Note: the order of the component bytes are R, G and B, which is opposite of COLORREF type on Windows.

The PaintQRCodeImageVector function writes the QRCode barcode in vector image format specified to a disk file.

  int __stdcall  PaintQRCodeImageVector(
      void * pEncodeResult,
      const wchar_t * wszFilename,
      int module_width_hm,
      int target_dpi,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

Note: the order of the component bytes are R, G and B, which is opposite of COLORREF type on Windows.

The PaintQRCodeImageRaster function writes the QRCode barcode in raster image format specified to IStream object.

  int __stdcall  PaintQRCodeImageRaster2(
      void * pEncodeResult,
      IStream * ostream,
      int pixelsPerModule,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

Note: the order of the component bytes are R, G and B, which is opposite of COLORREF type on Windows.

The PaintQRCodeImageVector function writes the QRCode barcode in vector image format specified to an IStream object.

  int __stdcall  PaintQRCodeImageVector2(
      void * pEncodeResult,
      IStream * ostream,
      int module_width_hm,
      int target_dpi,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

Note: the order of the component bytes are R, G and B, which is opposite of COLORREF type on Windows.

The PaintQRCodeImageClipboard function Creates a Windows Enhanced Meta File object and returns the handle.

  HENHMETAFILE __stdcall PaintQRCodeImageEMF(
      void * pEncodeResult,
      int module_len_hm,
      int target_dpi,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

Remarks

The caller should destroy this handle after using.

The QRCodeGetErrorMessage function retrieves a string that describes the error.

  const char *__stdcall  QRCodeGetErrorMessage(
      int errorno
  );

Parameters

Return Values

a read only string that describes the error.

Remarks

The string returned is a read only string. User should not modify the string directly.

The QRCodeResultGetBarcodeString2 function returns barcode string without requiring user to preallocate the buffer.

  const char *__stdcall  QRCodeResultGetBarcodeString2(
      void * pEncodeResult,
      const char * eol
  );

Parameters

Return Values

Pointer to a NUL terminated string that represents the barcode (barcode string). If the function failed due to insufficient memory, it returns NULL.

Remarks

The encoder result manages the buffer by itself. Caller should cache the string returned, but not the pointer, as the contents may change after another call of QRCodeResultBarcodeString2 is made.

The PaintQRCodeImageClipboard function Creates a Windows Enhanced Meta File object and place it into the clipboard.

  int __stdcall  PaintQRCodeImageClipboard(
      void * pEncodeResult,
      int module_width_hm,
      int target_dpi,
      int forecolor,
      int backcolor
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function QRCodeGetErrorMessage to obtain the description of the error.

The QRCodeGetParity function calculates the parity value based on the whole data encoded and split into multiple symbols.

  int __stdcall  QRCodeGetParity(
      const char * dataToEncode
  );

Parameters

Return Values

The parity value that groups the symbols. It should be between 0 and 255.

Remarks

The QR Code structural append features allows data to be split across multiple symbols ( < 16). A SA capable scanner reads the symbols one and one, and emits the data after all the symbols are read. Symbols belong to the same cluster share the same parity value, which is calculate based on the full data.