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. They are referenced in the PaintDataMatrixImageRaster function and PaintDataMatrixImageVector function.

The DataMatrixEncode function encodes data and returns a pointers that points to encoder result object.

  int __stdcall  DataMatrixEncode(
      const char * dataToEncode,
      int sizeIDRequested,
      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 DataMatrixGetErrorMessage 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 DataMatrixEncode2 is an abbreviated version of DataMatrixEncode.

  void *__stdcall    DataMatrixEncode2(
      const char * dataToEncode,
      int sizeIDRequested
  );

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 DestroyDataMatrixEncodeResult.

Remarks

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

The function DataMatrixEncode2 is an abbreviated version of DataMatrixEncode.

The function DataMatrixEncode2W is added in 5.1 release to encode Unicode strings.

  void *__stdcall    DataMatrixEncode2W(
      const wchar_t * dataToEncode,
      int sizeIDRequested
  );

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 DestroyDataMatrixEncodeResult.

Remarks

See the manual on the details how a wide string is handled. In this function, a pointer is returned instead of status code. A non-null return value indicates that no error occured. The pointer associated resource must be released by calling DestroyDataMatrixEncodeResult.

The DataMatrixResultGetSizeID function retrieves the size ID of the datamatrix barcode created.

  int __stdcall  DataMatrixResultGetSizeID(
      void * pEncodeResult
  );

Parameters

Return Values

The size ID of the DataMatrix barcode.

The DataMatrixResultGetBarcodeString function retrieves the barcode string that becomes a DataMatrix symbol after being formated with a DataMatrix font.

  int __stdcall  DataMatrixResultGetBarcodeString(
      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 funtion fails due to insufficient storage, it returns 0.

Remarks

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

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

  void __stdcall DestroyDataMatrixEncodeResult(
      void * pResult
  );

Parameters

Remarks

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

The PaintDataMatrixImageRaster function writes the DataMatrix barcode in raster image format specified to a disk file.

  int __stdcall  PaintDataMatrixImageRaster(
      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 DataMatrixGetErrorMessage 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 PaintDataMatrixImageVector function writes the DataMatrix barcode in vector image format specified to a disk file.

  int __stdcall  PaintDataMatrixImageVector(
      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 DataMatrixGetErrorMessage 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 PaintDataMatrixImageRaster function writes the DataMatrix barcode in raster image format specified to IStream object.

  int __stdcall  PaintDataMatrixImageRaster2(
      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 DataMatrixGetErrorMessage 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 PaintDataMatrixImageVector function writes the DataMatrix barcode in vector image format specified to an IStream object.

  int __stdcall  PaintDataMatrixImageVector2(
      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 DataMatrixGetErrorMessage 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 PaintDataMatrixImageClipboard function Creates a Windows Enhanced Meta File object and returns the handle.

  HENHMETAFILE __stdcall PaintDataMatrixImageEMF(
      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 DataMatrixGetErrorMessage to obtain the description of the error.

Remarks

The caller should destory this handle after using.

The DataMatrixGetErrorMessage function retrieves a string that describes the error.

  const char *__stdcall  DataMatrixGetErrorMessage(
      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 DataMatrixResultGetBarcodeString2 function returns barcode string without requiring user to preallocate the buffer.

  const char *__stdcall  DataMatrixResultGetBarcodeString2(
      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 DataMatrixResultBarcodeString2 is made.

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

  int __stdcall  PaintDataMatrixImageClipboard(
      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 DataMatrixGetErrorMessage to obtain the description of the error.