maxiapi.cpp File Reference

Public API functions for MaxiCode barcodes. More...


Functions

LONG BCGet_Maxi_Mode (t_BarCode* pBarCode)
 Gets current encoding mode for MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
See also:
BCSet_Maxi_Mode()
Return values:
4   This is the default
>0   Otherwise ----------------------------------------------------------------------------.


LONG BCGet_Maxi_AppendSum (t_BarCode* pBarCode)
 Gets total number of symbols in "Structured Append" mode of MaxiCode. Returns currently adjusted value \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
2..8   ] Otherwise
See also:
BCSet_Maxi_Append() ----------------------------------------------------------------------------.


LONG BCGet_Maxi_AppendIndex (t_BarCode* pBarCode)
 Gets index of current symbol in "Structured Append" mode of MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
1..8   ] Otherwise
See also:
BCSet_Maxi_Append() ----------------------------------------------------------------------------.


LONG BCGet_Maxi_UnderCut (t_BarCode* pBarCode)
 Gets current undercut value of MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
See also:
BCSet_Maxi_UnderCut()
Return values:
-1   No value set. This is the default and corresponds to 75% undercut.
1..100   ] Otherwise ----------------------------------------------------------------------------.


BOOL BCGet_Maxi_UsePreamble (t_BarCode* pBarCode)
 Determines whether the usage of the "Preamble" is activated. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
true   Preamble is activated
false   Preamble is not activated. This is the default
See also:
BCGSt_Maxi_UsePreamble() ----------------------------------------------------------------------------.


LPCSTR BCGet_Maxi_PreambleDateA (t_BarCode* pBarCode)
 Returns the current date encoded in the MaxiCode preamble. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
00...99   ] Otherwise
See also:
BCSet_Maxi_UsePreamble() ----------------------------------------------------------------------------.


LPCWSTR BCGet_Maxi_PreambleDateW (t_BarCode* pBarCode)
 Returns the current date encoded in the MaxiCode preamble. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
00...99   ] Otherwise
See also:
BCSet_Maxi_UsePreamble() ----------------------------------------------------------------------------.


LPCSTR BCGet_Maxi_SCMServClassA (t_BarCode* pBarCode)
 Gets service class of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
See also:
BCSet_Maxi_SCM()
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_Maxi_SCMServClassW (t_BarCode* pBarCode)
 Gets service class of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
See also:
BCSet_Maxi_SCM()
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_Maxi_SCMCountryCodeA (t_BarCode* pBarCode)
 Gets country code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.


LPCWSTR BCGet_Maxi_SCMCountryCodeW (t_BarCode* pBarCode)
 Gets country code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.


LPCSTR BCGet_Maxi_SCMPostalCodeA (t_BarCode* pBarCode)
 Gets postal code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
LPCSTR   See BCSet_Maxi_SCM()
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.


LPCWSTR BCGet_Maxi_SCMPostalCodeW (t_BarCode* pBarCode)
 Gets postal code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
LPCSTR   See BCSet_Maxi_SCM()
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_Mode (t_BarCode* pBarCode, LONG nMode)
 Specifies the operating mode for encoding data. Specifies the operating mode for encoding data. Default is Mode 4. \param[in] pBarCode Pointer to barcode structure. \param[in] nMode Used encoding mode [2..5] - Mode 2: SCM Numeric - Structured Carrier Message (Postal Code only numeric, up to 9 digits) - Mode 3: SCM Alphanumeric - Structured Carrier Message (Postal Code alphanumeric, up to 6 characters) - Mode 4: For numeric and alphanumeric character sequences (Standard Error Correction). This is the default - Mode 5: Full EEC - like Mode 4, but with Enhanced Error Correction (safer, but less usable data)
See also:
BCGet_Maxi_Mode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_Append (t_BarCode* pBarCode, LONG nSum, LONG nIndex)
 Activates MaxiCode "Structured Append" feature. MaxiCode 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 that enables the reading device to reconstruct the data of all symbols in the correct order.
these functions sets the total number of symbols and the index of the actual MaxiCode 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. \param[in] pBarCode Pointer to barcode structure. \param[in] nSum Total number of symbols [2..8]. \param[in] nIndex Index of current symbol [1..8].
See also:
BCGet_Maxi_Append()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_UnderCut (t_BarCode* pBarCode, LONG nUndercut)
 Specifies the undercut value of MaxiCode. This value influences the diameter of the barcode items (which are small hexagons in case of MaxiCode). Modify this value, if reading problems with the used output medium occur.
Note:
Default value: -1 (75% undercut) \param[in] pBarCode Pointer to barcode structure. \param[in] nUndercut Undercut in percent [1..100].
See also:
BCGet_Maxi_UnderCut()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_UsePreambleA (t_BarCode* pBarCode, BOOL bUse, LPCSTR szDate)
 Activates the usage of the "Preamble" in MaxiCode. Specifies whether preamble functionality ("[)>..." will be encoded in the symbol header) should be activated. This is relevant in particular Open System Standards only. Refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] bUse Use preamble ("[)>..."). - true: Activate preamble - false: Preamble is not used \param[in] szDate Specifies the value for the year ["00"..."99"] (the last two digits - the century - are used). This date will be inserted automatically into the data stream on a predefined place (before the encoded data). The parameter bUse must be set to true!
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCGet_Maxi_UsePreamble() ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_UsePreambleW (t_BarCode* pBarCode, BOOL bUse, LPCWSTR szDate)
 Activates the usage of the "Preamble" in MaxiCode. Specifies whether preamble functionality ("[)>..." will be encoded in the symbol header) should be activated. This is relevant in particular Open System Standards only. Refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] bUse Use preamble ("[)>..."). - true: Activate preamble - false: Preamble is not used \param[in] szDate Specifies the value for the year ["00"..."99"] (the last two digits - the century - are used). This date will be inserted automatically into the data stream on a predefined place (before the encoded data). The parameter bUse must be set to true!
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCGet_Maxi_UsePreamble() ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_SCMA (t_BarCode* pBarCode, LPCSTR szServiceClass, LPCSTR szCountryCode, LPCSTR szPostalCode)
 Set MaxiCode structured carrier message (SCM). For a detailed description refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] szServiceClass Service class ["000"..."999"]. Specify the Service Class. Used in the modes 2 and 3 (SCM). \param[in] szCountryCode Country Code ["000"..."999"]. Used in the modes 2 and 3 (SCM). \param[in] szPostalCode The Postal Code - used in the modes 2 and 3 (SCM - " Structured Carrier Message"). String with altogether 9 digits (or other characters), depends on MAXI_Mode.
See also:
BCGet_Maxi_SCMServClass(), BCGet_Maxi_SCMCountryCode(), BCGet_Maxi_SCMPostalCode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_Maxi_SCMW (t_BarCode* pBarCode, LPCWSTR szServiceClass, LPCWSTR szCountryCode, LPCWSTR szPostalCode)
 Set MaxiCode structured carrier message (SCM). For a detailed description refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] szServiceClass Service class ["000"..."999"]. Specify the Service Class. Used in the modes 2 and 3 (SCM). \param[in] szCountryCode Country Code ["000"..."999"]. Used in the modes 2 and 3 (SCM). \param[in] szPostalCode The Postal Code - used in the modes 2 and 3 (SCM - " Structured Carrier Message"). String with altogether 9 digits (or other characters), depends on MAXI_Mode.
See also:
BCGet_Maxi_SCMServClass(), BCGet_Maxi_SCMCountryCode(), BCGet_Maxi_SCMPostalCode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Detailed Description

Public API functions for MaxiCode 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_Maxi_AppendIndex ( t_BarCode * pBarCode )

Gets index of current symbol in "Structured Append" mode of MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
-1   No value set. This is the default
1..8   ] Otherwise
See also:
BCSet_Maxi_Append() ----------------------------------------------------------------------------.

LONG BCGet_Maxi_AppendSum ( t_BarCode * pBarCode )

Gets total number of symbols in "Structured Append" mode of MaxiCode. Returns currently adjusted value \param[in] pBarCode Pointer to barcode structure.

Return values:
-1   No value set. This is the default
2..8   ] Otherwise
See also:
BCSet_Maxi_Append() ----------------------------------------------------------------------------.

LONG BCGet_Maxi_Mode ( t_BarCode * pBarCode )

Gets current encoding mode for MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

See also:
BCSet_Maxi_Mode()
Return values:
4   This is the default
>0   Otherwise ----------------------------------------------------------------------------.

LPCSTR BCGet_Maxi_PreambleDateA ( t_BarCode * pBarCode )

Returns the current date encoded in the MaxiCode preamble. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
00...99   ] Otherwise
See also:
BCSet_Maxi_UsePreamble() ----------------------------------------------------------------------------.

LPCWSTR BCGet_Maxi_PreambleDateW ( t_BarCode * pBarCode )

Returns the current date encoded in the MaxiCode preamble. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
00...99   ] Otherwise
See also:
BCSet_Maxi_UsePreamble() ----------------------------------------------------------------------------.

LPCSTR BCGet_Maxi_SCMCountryCodeA ( t_BarCode * pBarCode )

Gets country code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
000...999   ] Otherwise
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.

LPCWSTR BCGet_Maxi_SCMCountryCodeW ( t_BarCode * pBarCode )

Gets country code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
000...999   ] Otherwise
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.

LPCSTR BCGet_Maxi_SCMPostalCodeA ( t_BarCode * pBarCode )

Gets postal code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
LPCSTR   See BCSet_Maxi_SCM()
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.

LPCWSTR BCGet_Maxi_SCMPostalCodeW ( t_BarCode * pBarCode )

Gets postal code of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
NULL   No value set. This is the default
LPCSTR   See BCSet_Maxi_SCM()
See also:
BCSet_Maxi_SCM() ----------------------------------------------------------------------------.

LPCSTR BCGet_Maxi_SCMServClassA ( t_BarCode * pBarCode )

Gets service class of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

See also:
BCSet_Maxi_SCM()
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise ----------------------------------------------------------------------------.

LPCWSTR BCGet_Maxi_SCMServClassW ( t_BarCode * pBarCode )

Gets service class of MaxiCode Structured Carrier Message (SCM). Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

See also:
BCSet_Maxi_SCM()
Return values:
NULL   No value set. This is the default
000...999   ] Otherwise ----------------------------------------------------------------------------.

LONG BCGet_Maxi_UnderCut ( t_BarCode * pBarCode )

Gets current undercut value of MaxiCode. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

See also:
BCSet_Maxi_UnderCut()
Return values:
-1   No value set. This is the default and corresponds to 75% undercut.
1..100   ] Otherwise ----------------------------------------------------------------------------.

BOOL BCGet_Maxi_UsePreamble ( t_BarCode * pBarCode )

Determines whether the usage of the "Preamble" is activated. Returns currently adjusted value. \param[in] pBarCode Pointer to barcode structure.

Return values:
true   Preamble is activated
false   Preamble is not activated. This is the default
See also:
BCGSt_Maxi_UsePreamble() ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_Append ( t_BarCode * pBarCode,
LONG nSum,
LONG nIndex )

Activates MaxiCode "Structured Append" feature. MaxiCode 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 that enables the reading device to reconstruct the data of all symbols in the correct order.
these functions sets the total number of symbols and the index of the actual MaxiCode 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. \param[in] pBarCode Pointer to barcode structure. \param[in] nSum Total number of symbols [2..8]. \param[in] nIndex Index of current symbol [1..8].

See also:
BCGet_Maxi_Append()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_Mode ( t_BarCode * pBarCode,
LONG nMode )

Specifies the operating mode for encoding data. Specifies the operating mode for encoding data. Default is Mode 4. \param[in] pBarCode Pointer to barcode structure. \param[in] nMode Used encoding mode [2..5] - Mode 2: SCM Numeric - Structured Carrier Message (Postal Code only numeric, up to 9 digits) - Mode 3: SCM Alphanumeric - Structured Carrier Message (Postal Code alphanumeric, up to 6 characters) - Mode 4: For numeric and alphanumeric character sequences (Standard Error Correction). This is the default - Mode 5: Full EEC - like Mode 4, but with Enhanced Error Correction (safer, but less usable data)

See also:
BCGet_Maxi_Mode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_SCMA ( t_BarCode * pBarCode,
LPCSTR szServiceClass,
LPCSTR szCountryCode,
LPCSTR szPostalCode )

Set MaxiCode structured carrier message (SCM). For a detailed description refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] szServiceClass Service class ["000"..."999"]. Specify the Service Class. Used in the modes 2 and 3 (SCM). \param[in] szCountryCode Country Code ["000"..."999"]. Used in the modes 2 and 3 (SCM). \param[in] szPostalCode The Postal Code - used in the modes 2 and 3 (SCM - " Structured Carrier Message"). String with altogether 9 digits (or other characters), depends on MAXI_Mode.

See also:
BCGet_Maxi_SCMServClass(), BCGet_Maxi_SCMCountryCode(), BCGet_Maxi_SCMPostalCode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_SCMW ( t_BarCode * pBarCode,
LPCWSTR szServiceClass,
LPCWSTR szCountryCode,
LPCWSTR szPostalCode )

Set MaxiCode structured carrier message (SCM). For a detailed description refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] szServiceClass Service class ["000"..."999"]. Specify the Service Class. Used in the modes 2 and 3 (SCM). \param[in] szCountryCode Country Code ["000"..."999"]. Used in the modes 2 and 3 (SCM). \param[in] szPostalCode The Postal Code - used in the modes 2 and 3 (SCM - " Structured Carrier Message"). String with altogether 9 digits (or other characters), depends on MAXI_Mode.

See also:
BCGet_Maxi_SCMServClass(), BCGet_Maxi_SCMCountryCode(), BCGet_Maxi_SCMPostalCode()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_UnderCut ( t_BarCode * pBarCode,
LONG nUndercut )

Specifies the undercut value of MaxiCode. This value influences the diameter of the barcode items (which are small hexagons in case of MaxiCode). Modify this value, if reading problems with the used output medium occur.

Note:
Default value: -1 (75% undercut) \param[in] pBarCode Pointer to barcode structure. \param[in] nUndercut Undercut in percent [1..100].
See also:
BCGet_Maxi_UnderCut()
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_UsePreambleA ( t_BarCode * pBarCode,
BOOL bUse,
LPCSTR szDate )

Activates the usage of the "Preamble" in MaxiCode. Specifies whether preamble functionality ("[)>..." will be encoded in the symbol header) should be activated. This is relevant in particular Open System Standards only. Refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] bUse Use preamble ("[)>..."). - true: Activate preamble - false: Preamble is not used \param[in] szDate Specifies the value for the year ["00"..."99"] (the last two digits - the century - are used). This date will be inserted automatically into the data stream on a predefined place (before the encoded data). The parameter bUse must be set to true!

Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCGet_Maxi_UsePreamble() ----------------------------------------------------------------------------.

ERRCODE BCSet_Maxi_UsePreambleW ( t_BarCode * pBarCode,
BOOL bUse,
LPCWSTR szDate )

Activates the usage of the "Preamble" in MaxiCode. Specifies whether preamble functionality ("[)>..." will be encoded in the symbol header) should be activated. This is relevant in particular Open System Standards only. Refer to the additional document Barcode Reference (chapter setting SCM parameters). \param[in] pBarCode Pointer to barcode structure. \param[in] bUse Use preamble ("[)>..."). - true: Activate preamble - false: Preamble is not used \param[in] szDate Specifies the value for the year ["00"..."99"] (the last two digits - the century - are used). This date will be inserted automatically into the data stream on a predefined place (before the encoded data). The parameter bUse must be set to true!

Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCGet_Maxi_UsePreamble() ----------------------------------------------------------------------------.

© 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