qrcodeapi.cpp File Reference

Functions

LPCSTR*

Returns implemented QR-Code versions. Returns all possible QR-Code versions (symbol sizes) in an array.
See also:
BCGetQRCodeVersionCount()
Return values:

LPCSTR * String array (size is available via BCGetQRCodeVersionCount()) ----------------------------------------------------------------------------.

LPCWSTR*

BCGetQRCodeVersionsW ()

LONG

BCGetQRCodeVersionCount ()

Returns number of implemented QR-Code versions. Returns the number of possible QR-Code versions
See also:
BCGetQRCodeVersions()
Return values:

LONG Number of supported QR-code versions ----------------------------------------------------------------------------.

e_QRVersion

BCGet_QR_Version (t_BarCode* pBarCode)

Gets the current symbol version (the symbol size). Returns currently adjusted value.
See also:
BCSet_QR_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:

eQRVers_Default No value set. This is the default and the minimal symbol size will be computed automatically

e_QRVersion Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_QR_Version (t_BarCode* pBarCode, e_QRVersion eVersion)

Specifies the symbol version (the symbol size). Specifies the size of the symbol. QR-Code supports a number of different symbol sizes - these sizes are called "versions" (see e_QRVersion). If no fixed size is selected TBarCode computes the minimal required size of the symbol automatically.
See also:
BCGet_QR_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_QRFormat

BCGet_QR_Format (t_BarCode* pBarCode)

Gets the current encoding format. Returns currently adjusted value.
See also:
BCSet_QR_Format() \param[in] pBarCode Pointer to barcode structure.
Return values:

eQRPr_Default No value set. This is the default

e_QRFormat Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_QR_Format (t_BarCode* pBarCode, e_QRFormat eFormat)

Specifies QR-Code encoding format. Specifies the generated code format. Per default TBarCode uses the default encoding scheme without a special header.
See also:
BCGet_QR_Format() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat eFormat QR-Code format.
Return values:

ERRCODE ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

LPCSTR

BCGet_QR_FmtAppIndicatorA (t_BarCode* pBarCode)

Gets current QR-Code Format application indicator (used with Industry format). Returns currently adjusted value.
See also:
BCSet_QR_FmtAppIndicator() \param[in] pBarCode Pointer to barcode structure.
Return values:

NULL No value set. This is the default

0...99 ],[a-z, A-Z] Otherwise ----------------------------------------------------------------------------.

LPCWSTR

BCGet_QR_FmtAppIndicatorW (t_BarCode* pBarCode)

e_QRECLevel

BCGet_QR_ECLevel (t_BarCode* pBarCode)

Gets the current QR-Code error correction level (ECL). Returns currently adjusted value.
See also:
BCSet_QR_ECLevel() \param[in] pBarCode Pointer to barcode structure.
Return values:

eQREC_Low This is the default

e_QRECLevel Otherwise ----------------------------------------------------------------------------.

e_QRMask

BCGet_QR_Mask (t_BarCode* pBarCode)

Gets the current QR-Code mask pattern (0-7). Returns currently adjusted value
See also:
BCSet_QR_Mask() \param[in] pBarCode Pointer to barcode structure.
Return values:

eQRMsk_Default No value set. This is the default

e_QRMask Otherwise ----------------------------------------------------------------------------.

e_QRMBCompaction

BCGet_QR_KanjiChineseCompaction (t_BarCode* pBarCode)

Gets the current state of the QR-Code "Compact Kanji / Chinese" option. Returns currently adjusted value
See also:
BCSet_QR_KanjiChineseCompaction() \param[in] pBarCode Pointer to bar-code structure.
Return values:

eQRMBCompactionNone Do not compact Multi Byte character sets (Default)

eQRMBCompactionKanji Kanji characters (Shift JIS X 0208) should be compacted

eQRMBCompactionChinese Chinese characters (GB2312) should be compacted ----------------------------------------------------------------------------.

LONG

BCGet_QR_AppendSum (t_BarCode* pBarCode)

Gets the total number of symbol when using QR-Code "Structured Append". Returns currently adjusted value.
See also:
BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

2..16 ] Otherwise ----------------------------------------------------------------------------.

LONG

BCGet_QR_AppendIndex (t_BarCode* pBarCode)

Gets the structured append index of the symbol when using QR-Code "Structured Append". Returns currently adjusted value.
See also:
BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

1..16 ] Otherwise ----------------------------------------------------------------------------.

BYTE

BCGet_QR_AppendParity (t_BarCode* pBarCode)

Gets the structured append parity when using QR-Code "Structured Append". Returns currently adjusted value.
See also:
BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:

0 No value set. This is the default

0..255 ] Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_QR_FmtAppIndicatorA (t_BarCode* pBarCode, LPCSTR szIndicator)

Set QR-Code format Application Indicator (used with Industry format). Is used only in connection with Industry-Format. The Application Indicator determines, to which industry format the input stream corresponds.
See also:
BCGet_QR_FmtAppIndicator() \param[in] pBarCode Pointer to barcode structure. \param[in] szIndicator Format application indicator ["0"..."99"] or [a-z, A-Z].
Return values:

ERRCODE ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE

BCSet_QR_FmtAppIndicatorW (t_BarCode* pBarCode, LPCWSTR szIndicator)

ERRCODE

BCSet_QR_ECLevel (t_BarCode* pBarCode, e_QRECLevel eECLevel)

Sets QR-Code error correction level (ECL). Sets QR-Code error correction level (ECL). If not set, TBarCode uses medium error correction level per default.
See also:
BCGet_QR_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_QR_Mask (t_BarCode* pBarCode, e_QRMask eMask)

Sets QR-Code mask pattern (0-7). Specifies the so-called "mask" that is applied to the QR-Code to achieve the highest possible readability. TBarCode computes the optimal mask automatically. This is very time consuming - if the encoding process must be optimized set a predefined mask.
See also:
BCGet_QR_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_QR_KanjiChineseCompaction (t_BarCode* pBarCode, e_QRMBCompaction eCompaction)

Enables QR-Code "Compact Kanji" or "Compact Chinese" option. Enables the compaction of Kanji or Simplified Chinese characters into 13-bit values. The characters must be passed on as Unicode (wide string functions) in combination with code page set to Shift JIS or Simplified Chinese. If you use encoding mode Low Byte, the Kanji-characters must be supplied in Shift JIS X 0208 and the Chinese characters in GB2312 (Simplified Chinese) multi byte character set. Compaction of Kanji characters is done according to ISO/IEC 18004 (and AIM ITS/97-001); Compaction of Chinese characters is done according to GB/T 18284-2000.
See also:
BCGet_QR_KanjiChineseCompaction() (), BCSetTextW(), BCSetCodePage()
Note:
Do not use this option for pure binary data or ASCII characters. Take care with QR-Code 2005, which has a different default encoding. \param[in] pBarCode Pointer to bar-code structure. \param[in] eCompaction Compact Kanji or Chinese option. - eQRMBCompactionDefault: compact Kanji characters if Codepage = Japanese Shift JIS - eQRMBCompactionNone: do not compact Multi Byte character sets - eQRMBCompactionKanji: Kanji characters (Shift JIS X 0208) should be compacted - eQRMBCompactionChinese: Chinese characters (GB2312) should be compacted
Return values:

ERRCODE ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE

BCSet_QR_Append (t_BarCode* pBarCode, LONG nSum, LONG nIndex, BYTE bParity)

Activates QR-Code "Structured Append" feature. QR-Code allows user data to be spread across several symbols. This might be done if the data is too large to fit into a single symbol or for reasons of appearance and geometry. The so called "Structured Append" mode encodes additional control information to enable the reading device to reconstruct the data of all symbols in the correct order. Default: Structured Append is disabled.
This function enables Structured Append and sets the total number of symbols and the index of the actual QR-Code symbol within the symbol chain. Depending on this index, the data will be reconstructed by the scanner during the reading process. The scanner returns the data of all symbols in the correct order at once.
All symbols within a symbol chain must be identified by a Parity. This parity is computed with BCCalcStructApp_Parity().
See also:
BCGet_QR_AppendSum(), BCGet_QR_AppendIndex(), BCGet_QR_AppendParity() \param[in] pBarCode Pointer to barcode structure. \param[in] nSum Total number of symbols [2..16] (reset to default/disable = -1). \param[in] nIndex Index of current symbol [1..16]. \param[in] bParity Parity byte (must be the same in all symbols).
Return values:

ERRCODE ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

BYTE

BCCalcStructApp_ParityA (LPCSTR szIntData, LONG nIntData)

Returns the parity byte for QR-Code "Structured Append" (Byte array version). Returns the parity byte for a given input data-stream. Used with QR-Code and structured append.
See also:
BCSet_QR_Append(), BCCalcStructApp_ParityW() \param[in] szIntData Input data of the complete QR-Code chain (byte array). \param[in] nIntData Length of szIntData.
Return values:

BYTE Value of the parity byte ----------------------------------------------------------------------------.

BYTE

BCCalcStructApp_ParityW (LPCWSTR szIntData, LONG nIntData)

LPCSTR*

BCGetMQRCodeVersionsA ()

Returns implemented Micro QR-Code versions. Returns all possible Micro QR-Code versions (symbol sizes) in an array.
See also:
BCGetMQRCodeVersionCount()
Return values:

LPCSTR * String array (size is available via BCGetMQRCodeVersionCount()) ----------------------------------------------------------------------------.

LPCWSTR*

BCGetMQRCodeVersionsW ()

LONG

BCGetMQRCodeVersionCount ()

Returns number of implemented Micro QR-Code versions. Returns the number of possible Micro QR-Code versions
See also:
BCGetMQRCodeVersions()
Return values:

LONG Number of supported Micro QR-code versions ----------------------------------------------------------------------------.

e_MQRVersion

BCGet_MQR_Version (t_BarCode* pBarCode)

Gets the current symbol version (the symbol size). Returns currently adjusted value.
See also:
BCSet_MQR_Version() \param[in] pBarCode Pointer to barcode structure.
Return values:

eMQRVers_Default No value set. This is the default and the minimal symbol size will be computed automatically

e_MQRVersion Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_MQR_Version (t_BarCode* pBarCode, e_MQRVersion eVersion)

Specifies the symbol version (the symbol size). Specifies the size of the symbol. Micro QR-code supports a number of different symbol sizes - these sizes are called "versions" (see e_MQRVersion). If no fixed size is selected TBarCode computes the minimal required size of the symbol automatically.
See also:
BCGet_MQR_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_MQRMask

BCGet_MQR_Mask (t_BarCode* pBarCode)

Gets the current Micro QR-Code mask pattern (0-7). Returns currently adjusted value
See also:
BCSet_MQR_Mask() \param[in] pBarCode Pointer to barcode structure.
Return values:

eMQRMsk_Default No value set. This is the default

e_MQRMask Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_MQR_Mask (t_BarCode* pBarCode, e_MQRMask eMask)

Sets Micro QR-Code mask pattern (0-7). Specifies the so-called "mask" that is applied to the Micro QR-Code to achieve the highest possible readability. TBarCode computes the optimal mask automatically. This is time consuming - if the encoding process must be optimized set a predefined mask.
See also:
BCGet_MQR_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. ----------------------------------------------------------------------------.

Detailed Description

Function Documentation

BYTE BCCalcStructApp_ParityA ( LPCSTR szIntData,

LONG nIntData )

Returns the parity byte for QR-Code "Structured Append" (Byte array version). Returns the parity byte for a given input data-stream. Used with QR-Code and structured append.

See also:: BCSet_QR_Append(), BCCalcStructApp_ParityW() \param[in] szIntData Input data of the complete QR-Code chain (byte array). \param[in] nIntData Length of szIntData.

Return values:

BYTE

Value of the parity byte ----------------------------------------------------------------------------.

BYTE BCCalcStructApp_ParityW ( LPCWSTR szIntData,

LONG nIntData )

Returns the parity byte for QR-Code "Structured Append" (Byte array version). Returns the parity byte for a given input data-stream. Used with QR-Code and structured append.

See also:: BCSet_QR_Append(), BCCalcStructApp_ParityW() \param[in] szIntData Input data of the complete QR-Code chain (byte array). \param[in] nIntData Length of szIntData.

Return values:

BYTE

Value of the parity byte ----------------------------------------------------------------------------.

Returns number of implemented Micro QR-Code versions. Returns the number of possible Micro QR-Code versions

See also:: BCGetMQRCodeVersions()

Return values:

LONG

Number of supported Micro QR-code versions ----------------------------------------------------------------------------.

Returns implemented Micro QR-Code versions. Returns all possible Micro QR-Code versions (symbol sizes) in an array.

See also:: BCGetMQRCodeVersionCount()

Return values:

LPCSTR

* String array (size is available via BCGetMQRCodeVersionCount()) ----------------------------------------------------------------------------.

Returns implemented Micro QR-Code versions. Returns all possible Micro QR-Code versions (symbol sizes) in an array.

See also:: BCGetMQRCodeVersionCount()

Return values:

LPCSTR

* String array (size is available via BCGetMQRCodeVersionCount()) ----------------------------------------------------------------------------.

Returns number of implemented QR-Code versions. Returns the number of possible QR-Code versions

See also:: BCGetQRCodeVersions()

Return values:

LONG

Number of supported QR-code versions ----------------------------------------------------------------------------.

Returns implemented QR-Code versions. Returns all possible QR-Code versions (symbol sizes) in an array.

See also:: BCGetQRCodeVersionCount()

Return values:

LPCSTR

* String array (size is available via BCGetQRCodeVersionCount()) ----------------------------------------------------------------------------.

Returns implemented QR-Code versions. Returns all possible QR-Code versions (symbol sizes) in an array.

See also:: BCGetQRCodeVersionCount()

Return values:

LPCSTR

* String array (size is available via BCGetQRCodeVersionCount()) ----------------------------------------------------------------------------.

Gets the current Micro QR-Code mask pattern (0-7). Returns currently adjusted value

See also:: BCSet_MQR_Mask() \param[in] pBarCode Pointer to barcode structure.

Return values:

eMQRMsk_Default	No value set. This is the default
e_MQRMask	Otherwise ----------------------------------------------------------------------------.

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

See also:: BCSet_MQR_Version() \param[in] pBarCode Pointer to barcode structure.

Return values:

eMQRVers_Default	No value set. This is the default and the minimal symbol size will be computed automatically
e_MQRVersion	Otherwise ----------------------------------------------------------------------------.

Gets the structured append index of the symbol when using QR-Code "Structured Append". Returns currently adjusted value.

See also:: BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.

Return values:

-1	No value set. This is the default
1..16	] Otherwise ----------------------------------------------------------------------------.

Gets the structured append parity when using QR-Code "Structured Append". Returns currently adjusted value.

See also:: BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.

Return values:

0	No value set. This is the default
0..255	] Otherwise ----------------------------------------------------------------------------.

Gets the total number of symbol when using QR-Code "Structured Append". Returns currently adjusted value.

See also:: BCSet_QR_Append() \param[in] pBarCode Pointer to barcode structure.

Return values:

-1	No value set. This is the default
2..16	] Otherwise ----------------------------------------------------------------------------.

Gets the current QR-Code error correction level (ECL). Returns currently adjusted value.

See also:: BCSet_QR_ECLevel() \param[in] pBarCode Pointer to barcode structure.

Return values:

eQREC_Low	This is the default
e_QRECLevel	Otherwise ----------------------------------------------------------------------------.

Gets current QR-Code Format application indicator (used with Industry format). Returns currently adjusted value.

See also:: BCSet_QR_FmtAppIndicator() \param[in] pBarCode Pointer to barcode structure.

Return values:

NULL	No value set. This is the default
0...99	],[a-z, A-Z] Otherwise ----------------------------------------------------------------------------.

Gets current QR-Code Format application indicator (used with Industry format). Returns currently adjusted value.

See also:: BCSet_QR_FmtAppIndicator() \param[in] pBarCode Pointer to barcode structure.

Return values:

NULL	No value set. This is the default
0...99	],[a-z, A-Z] Otherwise ----------------------------------------------------------------------------.

Gets the current encoding format. Returns currently adjusted value.

See also:: BCSet_QR_Format() \param[in] pBarCode Pointer to barcode structure.

Return values:

eQRPr_Default	No value set. This is the default
e_QRFormat	Otherwise ----------------------------------------------------------------------------.

Gets the current state of the QR-Code "Compact Kanji / Chinese" option. Returns currently adjusted value

See also:: BCSet_QR_KanjiChineseCompaction() \param[in] pBarCode Pointer to bar-code structure.

Return values:

eQRMBCompactionNone	Do not compact Multi Byte character sets (Default)
eQRMBCompactionKanji	Kanji characters (Shift JIS X 0208) should be compacted
eQRMBCompactionChinese	Chinese characters (GB2312) should be compacted ----------------------------------------------------------------------------.

Gets the current QR-Code mask pattern (0-7). Returns currently adjusted value

See also:: BCSet_QR_Mask() \param[in] pBarCode Pointer to barcode structure.

Return values:

eQRMsk_Default	No value set. This is the default
e_QRMask	Otherwise ----------------------------------------------------------------------------.

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

See also:: BCSet_QR_Version() \param[in] pBarCode Pointer to barcode structure.

Return values:

eQRVers_Default	No value set. This is the default and the minimal symbol size will be computed automatically
e_QRVersion	Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_MQR_Mask ( t_BarCode * pBarCode,

e_MQRMask eMask )

See also:: BCGet_MQR_Mask() \param[in] pBarCode Pointer to barcode structure. \param[in] eMask Mask pattern.

Return values:

ERRCODE