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 PaintPDF417ImageRaster function and PaintPDF417ImageVector function.

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

  int __stdcall  PDF417Encode(
      const char * dataToEncode,
      int numRows,
      int numCols,
      int securityLevel,
      int fullsizePDF,
      double aspectRatio,
      double yHeight,
      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 PDF417GetErrorMessage 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 PDF417Encode2 is an abbreviated version of PDF417Encode.

  void *__stdcall    PDF417Encode2(
      const char * dataToEncode,
      int numRows,
      int numCols,
      int securityLevel,
      int fullsizePDF,
      double aspectRatio,
      double yHeight
  );

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

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

The function PDF417Encode2 is an abbreviated version of PDF417Encode.

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

  void __stdcall DestroyPDF417EncodeResult(
      void * pResult
  );

Parameters

Remarks

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

The PDF417ResultGetNumRows function retrieves the number of rows of the PDF417 barcode created.

  int __stdcall  PDF417ResultGetNumRows(
      void * pEncodeResult
  );

Parameters

Return Values

The number of data rows in the PDF417 barcode. Always succeed.

The PDF417ResultGetNumCols function retrieves the number of data columns of the PDF417 barcode created.

  int __stdcall  PDF417ResultGetNumCols(
      void * pEncodeResult
  );

Parameters

Return Values

The number of data columns in the PDF417 barcode. Always succeed.

The PDF417ResultGetSecurityLevel function retrieves the security level of the PDF417 barcode created.

  int __stdcall  PDF417ResultGetSecurityLevel(
      void * pEncodeResult
  );

Parameters

Return Values

The actual security level in the PDF417 barcode. It should be a number bewteen 0 and 8.

Remarks

PDF417 specification defines nine different levels for security codewords, ranging between 0 and 9. In our software you can use 9 for automatic security level selection. The encoder always selects that the highest security level possible within the size constraint. To obtain the actual security level in the barcode, call function PDF417ResultGetSecurityLevel.

The PDF417ResultGetAspectRatio function retrieves the actual aspect ratio of the PDF417 barcode created.

  double __stdcall   PDF417ResultGetAspectRatio(
      void * pEncodeResult
  );

Parameters

Return Values

The actual aspect ratio of the PDF417 barcode.

Remarks

The Aspect Ratio refers to the ratio of height to width of a bar code symbol. A code twice as high as it is wide has an aspect ration of 2; a code twice as wide as it is high has an aspect ratio of 0.5.

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

  int __stdcall  PDF417ResultGetBarcodeString(
      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 PDF417Encode or PDF417Encode2 to obtain a pointer that points to the result object. Then PDF417ResultGetBarcodeString is called to obtain a string that becomes PDF417 symbol after the font is applied. If memory is not an issue, allocate a large buffer with 8096 bytes to hold the largest PDF417 barcode. This size is sufficient for the largest symbol with carriage return and line feed as line ending.

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

  const char *__stdcall  PDF417ResultGetBarcodeString2(
      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

This function was added in 4.1 release to make it easier for the caller to retrieve barcode string. 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 PDF417ResultBarcodeString2 is made.

The PDF417GetErrorMessage function retrieves a string that describes the error.

  const char *__stdcall  PDF417GetErrorMessage(
      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 PaintPDF417ImageRaster function writes the PDF417 barcode in raster image format specified to a disk file.

  int __stdcall  PaintPDF417ImageRaster(
      void * pEncodeResult,
      const char * lpszFilename,
      int pixelsPerModule,
      int forecolor,
      int backcolor,
      int imageType
  );

Parameters

Return Values

If the function failed, it returns the error code. You can call function PDF417GetErrorMessage 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 PaintPDF417ImageVector function writes the PDF417 barcode in vector image format specified to a disk file.

  int __stdcall  PaintPDF417ImageVector(
      void * pEncodeResult,
      const char * lpszFilename,
      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 PDF417GetErrorMessage 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 PaintPDF417ImageClipboard function Creates a Windows Enhanced Meta File object and place it into the clipboard.

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