hanxinapi.cpp File Reference

Public API functions for Han Xin Code. More...


Functions

LPCSTR* BCGetHanXinVersionsA ()
 Returns implemented Han Xin Code versions. Returns all possible Han Xin Code versions (symbol sizes) in an array.
See also:
BCGetHanXinVersionCount()
Return values:
LPCSTR   * String array (size is available via BCGetHanXinVersionCount()) ----------------------------------------------------------------------------.


LPCWSTR* BCGetHanXinVersionsW ()
 Returns implemented Han Xin Code versions. Returns all possible Han Xin Code versions (symbol sizes) in an array.
See also:
BCGetHanXinVersionCount()
Return values:
LPCSTR   * String array (size is available via BCGetHanXinVersionCount()) ----------------------------------------------------------------------------.


LONG BCGetHanXinVersionCount ()
 Returns number of implemented Han Xin Code versions. Returns the number of possible Han Xin Code versions
See also:
BCGetQRCodeVersions()
Return values:
LONG   Number of supported QR-code versions ----------------------------------------------------------------------------.


e_HanXinSizes BCGet_HanXin_Version (t_BarCode* pBarCode)
 Gets the current symbol version (the symbol size). Returns currently adjusted value.
See also:
BCSet_HanXin_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:
eHanXinVers_Default   No value set. This is the default and the minimal symbol size will be computed automatically
e_HanXinSizes   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_HanXin_Version (t_BarCode* pBarCode, e_HanXinSizes eVersion)
 Specifies the symbol version (the symbol size). Specifies the size of the symbol. Han Xin Code supports a number of different symbol sizes - these sizes are called "versions" (see e_HanXinSizes). If no fixed size is selected TBarCode computes the minimal required size of the symbol automatically.
See also:
BCGet_HanXin_Version() \param[in] pBarCode Pointer to barcode structure. \param[in] eVersion Symbol version (size).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


e_HanXinECLevel BCGet_HanXin_ECLevel (t_BarCode* pBarCode)
 Gets the current Han Xin Code error correction level (ECL). Returns currently adjusted value.
See also:
BCSet_HanXin_ECLevel() \param[in] pBarCode Pointer to barcode structure.
Return values:
eHanXinEC_L1   This is the default
e_HanXinECLevel   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_HanXin_ECLevel (t_BarCode* pBarCode, e_HanXinECLevel eECLevel)
 Sets Han Xin Code error correction level (ECL). Sets Han Xin Code error correction level (ECL). If not set, TBarCode uses error correction level "1" per default.
See also:
BCGet_HanXin_ECLevel() \param[in] pBarCode Pointer to barcode structure. \param[in] eECLevel Error correction level.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


e_HanXinMask BCGet_HanXin_Mask (t_BarCode* pBarCode)
 Gets the current Han Xin Code mask pattern (0-3). Returns currently adjusted value
See also:
BCSet_HanXin_Mask() \param[in] pBarCode Pointer to barcode structure.
Return values:
eHanXinMsk_Default   No value set. This is the default
e_HanXinMask   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_HanXin_Mask (t_BarCode* pBarCode, e_HanXinMask eMask)
 Sets Han Xin Code mask pattern (0-3). Specifies the so-called "mask" that is applied to the Han Xin Code to achieve the highest possible readability. TBarCode computes the optimal mask automatically. This is somewhat time consuming - if the encoding process must be optimized set a predefined mask.
See also:
BCGet_HanXin_Mask() \param[in] pBarCode Pointer to barcode structure. \param[in] eMask Mask pattern.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


BOOL BCGet_HanXin_EnforceBinaryEncoding (t_BarCode* pBarCode)
 Determines whether the data is encoded in binary format. Returns TRUE if data is encoded in binary mode only, otherwise FALSE
See also:
BCSet_HanXin_EnforceBinaryEncoding() \param[in] pBarCode Pointer to barcode structure.
Return values:
TRUE   data is encoded in binary format
FALSE   data is encoded in mixed (=text and binary) format ----------------------------------------------------------------------------.


ERRCODE BCSet_HanXin_EnforceBinaryEncoding (t_BarCode* pBarCode, BOOL bEnforceBinary)
 Determines whether Han Xin Code shall be encoded in binary mode or not.
Note:
Binary mode usually is faster but produces bigger symbols than optimized symbol mode
See also:
BCGet_HanXin_EnforceBinaryEncoding() \param[in] pBarCode Pointer to barcode structure. \param[in] bEnforceBinary enforce binary encoding mode (true/false).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Detailed Description

Public API functions for Han Xin Code.

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 BCGetHanXinVersionCount ( )

Returns number of implemented Han Xin Code versions. Returns the number of possible Han Xin Code versions

See also:
BCGetQRCodeVersions()
Return values:
LONG   Number of supported QR-code versions ----------------------------------------------------------------------------.

LPCSTR * BCGetHanXinVersionsA ( )

Returns implemented Han Xin Code versions. Returns all possible Han Xin Code versions (symbol sizes) in an array.

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

LPCWSTR * BCGetHanXinVersionsW ( )

Returns implemented Han Xin Code versions. Returns all possible Han Xin Code versions (symbol sizes) in an array.

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

e_HanXinECLevel BCGet_HanXin_ECLevel ( t_BarCode * pBarCode )

Gets the current Han Xin Code error correction level (ECL). Returns currently adjusted value.

See also:
BCSet_HanXin_ECLevel() \param[in] pBarCode Pointer to barcode structure.
Return values:
eHanXinEC_L1   This is the default
e_HanXinECLevel   Otherwise ----------------------------------------------------------------------------.

BOOL BCGet_HanXin_EnforceBinaryEncoding ( t_BarCode * pBarCode )

Determines whether the data is encoded in binary format. Returns TRUE if data is encoded in binary mode only, otherwise FALSE

See also:
BCSet_HanXin_EnforceBinaryEncoding() \param[in] pBarCode Pointer to barcode structure.
Return values:
TRUE   data is encoded in binary format
FALSE   data is encoded in mixed (=text and binary) format ----------------------------------------------------------------------------.

e_HanXinMask BCGet_HanXin_Mask ( t_BarCode * pBarCode )

Gets the current Han Xin Code mask pattern (0-3). Returns currently adjusted value

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

e_HanXinSizes BCGet_HanXin_Version ( t_BarCode * pBarCode )

Gets the current symbol version (the symbol size). Returns currently adjusted value.

See also:
BCSet_HanXin_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:
eHanXinVers_Default   No value set. This is the default and the minimal symbol size will be computed automatically
e_HanXinSizes   Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_HanXin_ECLevel ( t_BarCode * pBarCode,
e_HanXinECLevel eECLevel )

Sets Han Xin Code error correction level (ECL). Sets Han Xin Code error correction level (ECL). If not set, TBarCode uses error correction level "1" per default.

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

ERRCODE BCSet_HanXin_EnforceBinaryEncoding ( t_BarCode * pBarCode,
BOOL bEnforceBinary )

Determines whether Han Xin Code shall be encoded in binary mode or not.

Note:
Binary mode usually is faster but produces bigger symbols than optimized symbol mode
See also:
BCGet_HanXin_EnforceBinaryEncoding() \param[in] pBarCode Pointer to barcode structure. \param[in] bEnforceBinary enforce binary encoding mode (true/false).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_HanXin_Mask ( t_BarCode * pBarCode,
e_HanXinMask eMask )

Sets Han Xin Code mask pattern (0-3). Specifies the so-called "mask" that is applied to the Han Xin Code to achieve the highest possible readability. TBarCode computes the optimal mask automatically. This is somewhat time consuming - if the encoding process must be optimized set a predefined mask.

See also:
BCGet_HanXin_Mask() \param[in] pBarCode Pointer to barcode structure. \param[in] eMask Mask pattern.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_HanXin_Version ( t_BarCode * pBarCode,
e_HanXinSizes eVersion )

Specifies the symbol version (the symbol size). Specifies the size of the symbol. Han Xin Code supports a number of different symbol sizes - these sizes are called "versions" (see e_HanXinSizes). If no fixed size is selected TBarCode computes the minimal required size of the symbol automatically.

See also:
BCGet_HanXin_Version() \param[in] pBarCode Pointer to barcode structure. \param[in] eVersion Symbol 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