micpdfapi.cpp File Reference

Public API functions for Micro PDF. More...


Functions

LPCSTR* BCGet_MPDF417_VersionsA ()
 Returns all possible MicroPDF417 versions (symbol sizes) in an array.
See also:
BCGet_MPDF417_VersionCount()
Return values:
LPCSTR   * String array (size is available via BCGet_MPDF417_VersionCount()) ----------------------------------------------------------------------------.


LPCWSTR* BCGet_MPDF417_VersionsW ()
 Returns all possible MicroPDF417 versions (symbol sizes) in an array.
See also:
BCGet_MPDF417_VersionCount()
Return values:
LPCSTR   * String array (size is available via BCGet_MPDF417_VersionCount()) ----------------------------------------------------------------------------.


LONG BCGet_MPDF417_VersionCount ()
 Returns number of implemented MicroPDF417 versions.
See also:
BCGet_MPDF417_Versions()
Return values:
LONG   Number of supported MicroPDf417 versions ----------------------------------------------------------------------------.


e_MPDFMode BCGet_MPDF417_Mode (t_BarCode* pBarCode)
 Gets Micro PDF encoding mode. Returns currently adjusted value.
See also:
BCSet_MPDF417_Mode() \param[in] pBarCode Pointer to barcode structure.
Return values:
eMPDFPr_Default   No value set. This is the default
e_MPDFMode   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_MPDF417_Mode (t_BarCode* pBarCode, e_MPDFMode eMode)
 Sets Micro PDF encoding mode. This option adjusts how data is encoded as MicroPDF417 and if the scanner should emulate Code-128. In most cases the Default mode is the best choice. Often the scanner hardware does not support all modes listed here - check with your reading device first. If not set explicitly, TBarCode analyzes input data. Text, numeric or binary compaction mode will be switched automatically in order to produce the smallest possible symbol.
See also:
BCGet_MPDF417_Mode() \param[in] pBarCode Pointer to barcode structure. \param[in] eMode Encoding mode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


e_MPDFVers BCGet_MPDF417_Version (t_BarCode* pBarCode)
 Gets Micro PDF Version (symbol size). Returns currently adjusted value.
See also:
BCSet_MPDF417_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:
eMPDFVer_Default   No value set. This is the default
e_MPDFVers   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_MPDF417_Version (t_BarCode* pBarCode, e_MPDFVers eVersion)
 Sets Micro PDF Version (symbol size). The MicroPDF Version adjusts the number of data-columns and data-rows of the symbol; therefore it specifies the size of the symbol. You can specify versions between 1x11 to 4x44 (horizontal data-columns x vertical data-rows). If not set explicitly, TBarCode generates the smallest possible symbol by analyzing the input data and choosing the suitable version automatically.
See also:
BCGet_MPDF417_Version() \param[in] pBarCode Pointer to barcode structure. \param[in] eVersion Version (size).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Detailed Description

Public API functions for Micro PDF.

Required include file: "tbarcode.h"

Author(s):
TEC-IT Datenverarbeitung GmbH
Wagnerstr. 6, 4400 Steyr, AUSTRIA/EUROPE
https://www.tec-it.com
Copyright© by TEC-IT Datenverarbeitung GmbH

Function Documentation

e_MPDFMode BCGet_MPDF417_Mode ( t_BarCode * pBarCode )

Gets Micro PDF encoding mode. Returns currently adjusted value.

See also:
BCSet_MPDF417_Mode() \param[in] pBarCode Pointer to barcode structure.
Return values:
eMPDFPr_Default   No value set. This is the default
e_MPDFMode   Otherwise ----------------------------------------------------------------------------.

e_MPDFVers BCGet_MPDF417_Version ( t_BarCode * pBarCode )

Gets Micro PDF Version (symbol size). Returns currently adjusted value.

See also:
BCSet_MPDF417_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:
eMPDFVer_Default   No value set. This is the default
e_MPDFVers   Otherwise ----------------------------------------------------------------------------.

LONG BCGet_MPDF417_VersionCount ( )

Returns number of implemented MicroPDF417 versions.

See also:
BCGet_MPDF417_Versions()
Return values:
LONG   Number of supported MicroPDf417 versions ----------------------------------------------------------------------------.

LPCSTR * BCGet_MPDF417_VersionsA ( )

Returns all possible MicroPDF417 versions (symbol sizes) in an array.

See also:
BCGet_MPDF417_VersionCount()
Return values:
LPCSTR   * String array (size is available via BCGet_MPDF417_VersionCount()) ----------------------------------------------------------------------------.

LPCWSTR * BCGet_MPDF417_VersionsW ( )

Returns all possible MicroPDF417 versions (symbol sizes) in an array.

See also:
BCGet_MPDF417_VersionCount()
Return values:
LPCSTR   * String array (size is available via BCGet_MPDF417_VersionCount()) ----------------------------------------------------------------------------.

ERRCODE BCSet_MPDF417_Mode ( t_BarCode * pBarCode,
e_MPDFMode eMode )

Sets Micro PDF encoding mode. This option adjusts how data is encoded as MicroPDF417 and if the scanner should emulate Code-128. In most cases the Default mode is the best choice. Often the scanner hardware does not support all modes listed here - check with your reading device first. If not set explicitly, TBarCode analyzes input data. Text, numeric or binary compaction mode will be switched automatically in order to produce the smallest possible symbol.

See also:
BCGet_MPDF417_Mode() \param[in] pBarCode Pointer to barcode structure. \param[in] eMode Encoding mode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_MPDF417_Version ( t_BarCode * pBarCode,
e_MPDFVers eVersion )

Sets Micro PDF Version (symbol size). The MicroPDF Version adjusts the number of data-columns and data-rows of the symbol; therefore it specifies the size of the symbol. You can specify versions between 1x11 to 4x44 (horizontal data-columns x vertical data-rows). If not set explicitly, TBarCode generates the smallest possible symbol by analyzing the input data and choosing the suitable version automatically.

See also:
BCGet_MPDF417_Version() \param[in] pBarCode Pointer to barcode structure. \param[in] eVersion Version (size).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

© 2019 All rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Sat Jul 13 03:16:06 2019 for TBarCode Library 11 with doxygen 1.1.5