pdf417api.cpp File Reference

Public API functions for PDF417 barcodes. More...


Functions

LONG BCGet_PDF417_Rows (t_BarCode* pBarCode)
 Gets number of PDF417 rows. Returns currently adjusted value.
See also:
BCSet_PDF417_Rows() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
3...90   ] Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_Rows (t_BarCode* pBarCode, LONG nRows)
 Sets number of PDF417 rows. Sets the number of graphic rows for PDF417 to a fixed value. If not set, the number of rows is calculated automatically by TBarCode (this is the default).
See also:
BCGet_PDF417_Rows() \param[in] pBarCode Pointer to barcode structure. \param[in] nRows Number of rows [3..90] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


LONG BCGet_PDF417_Columns (t_BarCode* pBarCode)
 Gets number of PDF417 columns. Returns currently adjusted value.
See also:
BCSet_PDF417_Columns() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
1...30   ] Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_Columns (t_BarCode* pBarCode, LONG nColumns)
 Sets the number of PDF417 columns. Sets the number of graphic columns [1...30] for PDF417 to a fixed value. If not set, the number of columns is calculated automatically by TBarCode (this is the default).
See also:
BCGet_PDF417_Columns() \param[in] pBarCode Pointer to barcode structure. \param[in] nColumns Number of columns [1..30] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


LONG BCGet_PDF417_ECLevel (t_BarCode* pBarCode)
 Gets current PDF417 error correction level. Returns currently adjusted value.
See also:
BCSet_PDF417_ECLEvel() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
0...8   ] Otherwise ----------------------------------------------------------------------------.


LONG BCGet_PDF417_RowHeight (t_BarCode* pBarCode)
 Gets PDF417 row-height. Returns currently adjusted value.
See also:
BCSet_PDF417_RowHeight() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise [1/1000 mm] ----------------------------------------------------------------------------.


LPCSTR BCGet_PDF417_RowColRatioA (t_BarCode* pBarCode)
 Gets PDF417 row to column ratio. Returns currently adjusted value.
See also:
BCSet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise "rows:columns" ----------------------------------------------------------------------------.


LPCWSTR BCGet_PDF417_RowColRatioW (t_BarCode* pBarCode)
 Gets PDF417 row to column ratio. Returns currently adjusted value.
See also:
BCSet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise "rows:columns" ----------------------------------------------------------------------------.


LONG BCGet_PDF417_CodeWords (t_BarCode* pBarCode)
 Gets number of PDF417 code words. Gets number of PDF417 code words.
Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure.
Return values:
LONG   Number of used PDF417 code words ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_ECLevel (t_BarCode* pBarCode, LONG nLevel)
 Sets PDF417 error correction level. Set the "Error Correction Level" for PDF417 to a fixed value. Possible values are [0...8] where 0 means only error recognition (no EC) and 8 means the highest level of EC. If not set, the error correction level is chosen automatically by TBarCode.
See also:
BCGet_PDF417_ECLevel() \param[in] pBarCode Pointer to barcode structure. \param[in] nLevel Error correction level [0..8] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_RowHeight (t_BarCode* pBarCode, LONG nHeight)
 Sets PDF417 row height to a fixed value. Sets the height of a PDF417 row tow a fixed value [1/1000 mm]. If not set, the height is calculated automatically by TBarCode with respect to the bounding rectangle passed to BCDraw (..).
Note:
If set, ensure that the bounding rectangle is big enough to avoid clipping.
See also:
BCGet_PDF417_RowHeight() \param[in] pBarCode Pointer to barcode structure. \param[in] nHeight Row height [1/1000 mm] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_RowColRatioA (t_BarCode* pBarCode, LPCSTR szRatio)
 Sets PDF417 row to column ratio to a fixed value. Sets the ratio between PDF417-rows and PDF417-columns. Does only work, if neither the value of PDF417-rows (BCSet_PDF417_Rows()) nor PDF417-columns (BCSet_PDF417_Columns()) are set to a constant value. If not set, the row:column ratio is chosen automatically by TBarCode (default).
See also:
BCGet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Ratio-string "rows:columns" in the form "3:5" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_RowColRatioW (t_BarCode* pBarCode, LPCWSTR szRatio)
 Sets PDF417 row to column ratio to a fixed value. Sets the ratio between PDF417-rows and PDF417-columns. Does only work, if neither the value of PDF417-rows (BCSet_PDF417_Rows()) nor PDF417-columns (BCSet_PDF417_Columns()) are set to a constant value. If not set, the row:column ratio is chosen automatically by TBarCode (default).
See also:
BCGet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Ratio-string "rows:columns" in the form "3:5" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


e_PDFMode BCGet_PDF417_EncodingMode (t_BarCode* pBarCode)
 Gets the current PDF417 encoding mode. Gets the current PDF417 encoding mode, which can be default or binary. \param[in] pBarCode Pointer to barcode structure.
Return values:
e_PDFMode   The PDF417 encoding mode ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_EncodingMode (t_BarCode* pBarCode, e_PDFMode eMode)
 Sets PDF417 encoding mode. Sets the PFD417 encoding mode. If the mode is set to default the generation algorithm tries to find an optimum encoding. If binary data is encoded, binary encoding is most of the time the better choice.
See also:
BCGet_PDF417_EncodationMode() \param[in] pBarCode Pointer to barcode structure. \param[in] eMode encoding mode. Can be default or binary.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Detailed Description

Public API functions for PDF417 barcodes.

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

LONG BCGet_PDF417_CodeWords ( t_BarCode * pBarCode )

Gets number of PDF417 code words. Gets number of PDF417 code words.

Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure.
Return values:
LONG   Number of used PDF417 code words ----------------------------------------------------------------------------.

LONG BCGet_PDF417_Columns ( t_BarCode * pBarCode )

Gets number of PDF417 columns. Returns currently adjusted value.

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

LONG BCGet_PDF417_ECLevel ( t_BarCode * pBarCode )

Gets current PDF417 error correction level. Returns currently adjusted value.

See also:
BCSet_PDF417_ECLEvel() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
0...8   ] Otherwise ----------------------------------------------------------------------------.

e_PDFMode BCGet_PDF417_EncodingMode ( t_BarCode * pBarCode )

Gets the current PDF417 encoding mode. Gets the current PDF417 encoding mode, which can be default or binary. \param[in] pBarCode Pointer to barcode structure.

Return values:
e_PDFMode   The PDF417 encoding mode ----------------------------------------------------------------------------.

LPCSTR BCGet_PDF417_RowColRatioA ( t_BarCode * pBarCode )

Gets PDF417 row to column ratio. Returns currently adjusted value.

See also:
BCSet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise "rows:columns" ----------------------------------------------------------------------------.

LPCWSTR BCGet_PDF417_RowColRatioW ( t_BarCode * pBarCode )

Gets PDF417 row to column ratio. Returns currently adjusted value.

See also:
BCSet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise "rows:columns" ----------------------------------------------------------------------------.

LONG BCGet_PDF417_RowHeight ( t_BarCode * pBarCode )

Gets PDF417 row-height. Returns currently adjusted value.

See also:
BCSet_PDF417_RowHeight() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise [1/1000 mm] ----------------------------------------------------------------------------.

LONG BCGet_PDF417_Rows ( t_BarCode * pBarCode )

Gets number of PDF417 rows. Returns currently adjusted value.

See also:
BCSet_PDF417_Rows() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
3...90   ] Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_Columns ( t_BarCode * pBarCode,
LONG nColumns )

Sets the number of PDF417 columns. Sets the number of graphic columns [1...30] for PDF417 to a fixed value. If not set, the number of columns is calculated automatically by TBarCode (this is the default).

See also:
BCGet_PDF417_Columns() \param[in] pBarCode Pointer to barcode structure. \param[in] nColumns Number of columns [1..30] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_ECLevel ( t_BarCode * pBarCode,
LONG nLevel )

Sets PDF417 error correction level. Set the "Error Correction Level" for PDF417 to a fixed value. Possible values are [0...8] where 0 means only error recognition (no EC) and 8 means the highest level of EC. If not set, the error correction level is chosen automatically by TBarCode.

See also:
BCGet_PDF417_ECLevel() \param[in] pBarCode Pointer to barcode structure. \param[in] nLevel Error correction level [0..8] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_EncodingMode ( t_BarCode * pBarCode,
e_PDFMode eMode )

Sets PDF417 encoding mode. Sets the PFD417 encoding mode. If the mode is set to default the generation algorithm tries to find an optimum encoding. If binary data is encoded, binary encoding is most of the time the better choice.

See also:
BCGet_PDF417_EncodationMode() \param[in] pBarCode Pointer to barcode structure. \param[in] eMode encoding mode. Can be default or binary.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_RowColRatioA ( t_BarCode * pBarCode,
LPCSTR szRatio )

Sets PDF417 row to column ratio to a fixed value. Sets the ratio between PDF417-rows and PDF417-columns. Does only work, if neither the value of PDF417-rows (BCSet_PDF417_Rows()) nor PDF417-columns (BCSet_PDF417_Columns()) are set to a constant value. If not set, the row:column ratio is chosen automatically by TBarCode (default).

See also:
BCGet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Ratio-string "rows:columns" in the form "3:5" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_RowColRatioW ( t_BarCode * pBarCode,
LPCWSTR szRatio )

Sets PDF417 row to column ratio to a fixed value. Sets the ratio between PDF417-rows and PDF417-columns. Does only work, if neither the value of PDF417-rows (BCSet_PDF417_Rows()) nor PDF417-columns (BCSet_PDF417_Columns()) are set to a constant value. If not set, the row:column ratio is chosen automatically by TBarCode (default).

See also:
BCGet_PDF417_RowColRatio() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Ratio-string "rows:columns" in the form "3:5" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_RowHeight ( t_BarCode * pBarCode,
LONG nHeight )

Sets PDF417 row height to a fixed value. Sets the height of a PDF417 row tow a fixed value [1/1000 mm]. If not set, the height is calculated automatically by TBarCode with respect to the bounding rectangle passed to BCDraw (..).

Note:
If set, ensure that the bounding rectangle is big enough to avoid clipping.
See also:
BCGet_PDF417_RowHeight() \param[in] pBarCode Pointer to barcode structure. \param[in] nHeight Row height [1/1000 mm] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_Rows ( t_BarCode * pBarCode,
LONG nRows )

Sets number of PDF417 rows. Sets the number of graphic rows for PDF417 to a fixed value. If not set, the number of rows is calculated automatically by TBarCode (this is the default).

See also:
BCGet_PDF417_Rows() \param[in] pBarCode Pointer to barcode structure. \param[in] nRows Number of rows [3..90] (-1 ... reset to default).
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