dmapi.cpp File Reference

Public API functions for Data Matrix. More...


Functions

e_DMSizes BCGet_DM_Size (t_BarCode* pBarCode)
 Gets currently adjusted Data Matrix symbol size. Returns currently adjusted value.
See also:
BCSet_DM_Size() \param[in] pBarCode Pointer to barcode structure.
Return values:
eDMSz_Default   No value set. This is the default (TBarCode determines the optimal symbol size automatically)
e_DMSizes   Otherwise ----------------------------------------------------------------------------.


BOOL BCGet_DM_Rectangular (t_BarCode* pBarCode)
 Gets if rectangular Data Matrix sizes are preferred. Returns currently adjusted value.
See also:
BCSet_DM_Rectangular() \param[in] pBarCode Pointer to barcode structure.
Return values:
false   Square sizes are preferred. This is the default
true   Rectangular sizes are preferred. ----------------------------------------------------------------------------.


e_DMFormat BCGet_DM_Format (t_BarCode* pBarCode)
 Gets the current Data Matrix Encoding Format. Returns currently adjusted value
See also:
BCSet_DM_Format() \param[in] pBarCode Pointer to barcode structure.
Return values:
eDMPr_Default   This is the default
e_DMFormat   Otherwise ----------------------------------------------------------------------------.


BOOL BCGet_DM_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_DM_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 ----------------------------------------------------------------------------.


LONG BCGet_DM_AppendSum (t_BarCode* pBarCode)
 Gets the adjusted total number of symbols in Data Matrix Structured Append mode. Returns currently adjusted value
See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
2..16   ] Otherwise ----------------------------------------------------------------------------.


LONG BCGet_DM_AppendIndex (t_BarCode* pBarCode)
 Gets the current index of the symbol in Data Matrix Structured Append mode. Returns currently adjusted value.
See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
1..16   ] Otherwise ----------------------------------------------------------------------------.


LONG BCGet_DM_AppendFileID (t_BarCode* pBarCode)
 Gets the adjusted File-ID in Data Matrix Structured Append mode. Returns currently adjusted value.
See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
LONG   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_DM_Size (t_BarCode* pBarCode, e_DMSizes eSize)
 Sets Data Matrix symbol size. Specifies the size of the symbol. The size is given in rows and columns and can be between 10 x 10 and 144 x 144 for squares or 8 x 18 and 26 x 64 for rectangles. The Data Matrix Rectangular Extension (DMRE) specifies the matrix range from 8 x 48 to 26 x 64.
Note:
Each matrix size has a limited data capacity. If the amount of data cannot be encoded with the selected matrix, an error will be raised. If no fixed size is selected TBarCode computes and selects the minimal required size of the symbol automatically.
See also:
BCGet_DM_Size() BCSet_DM_Rectangular() \param[in] pBarCode Pointer to barcode structure. \param[in] eSize Bar-code size enumerator.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_DM_Rectangular (t_BarCode* pBarCode, BOOL bRect)
 Switches between square or rectangular Data Matrix symbols. Per default TBarCode computes square Data Matrix symbols. Change this behavior with this function.
See also:
BCGet_DM_Rectangular() BCSet_DM_Size() \param[in] pBarCode Pointer to barcode structure. \param[in] bRect Rectangular symbols preferred. - true: Generate rectangular symbols - false: Generate square symbols (this is the default)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_DM_Format (t_BarCode* pBarCode, e_DMFormat eFormat)
 Specifies Data Matrix encoding format. Specifies the generated code format. Per default TBarCode uses the default encoding scheme.
See also:
BCGet_DM_Format() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Data Matrix format.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_DM_EnforceBinaryEncoding (t_BarCode* pBarCode, BOOL bEnforceBinary)
 Determines whether Data Matrix shall be encoded in binary mode or not.
Note:
Binary mode usually is faster but produces bigger symbols than text mode
See also:
BCGet_DM_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_DM_Append (t_BarCode* pBarCode, LONG nSum, LONG nIndex, LONG nFileID)
 Activates Data Matrix "Structured Append" mode. Data Matrix 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. This function sets the total number of symbols and the index of the actual Data Matrix 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. Default: Standard Structured Append is used.
Note:
All symbols within a symbol chain must be identified by a unique File-ID.
See also:
BCGet_DM_AppendSum(), BCGet_DM_AppendIndex(), BCGet_DM_AppendFileID() \param[in] pBarCode Pointer to barcode structure. \param[in] nSum Number of symbols [2..16] (reset to default/disable = -1). \param[in] nIndex Index of symbol [1..16]. \param[in] nFileID File ID (must be the same in all symbols).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


LPCSTR* BCGetDataMatrixSizesA ()
 Returns implemented Data Matrix symbol sizes. Returns all possible Data Matrix symbol-sizes in an array.
See also:
BCGetDataMatrixSizesCount()
Return values:
LPCSTR   * String array (size is available via BCGetDataMatrixSizesCount()) ----------------------------------------------------------------------------.


LPCWSTR* BCGetDataMatrixSizesW ()
 Returns implemented Data Matrix symbol sizes. Returns all possible Data Matrix symbol-sizes in an array.
See also:
BCGetDataMatrixSizesCount()
Return values:
LPCSTR   * String array (size is available via BCGetDataMatrixSizesCount()) ----------------------------------------------------------------------------.


e_DMSizes* BCGetDataMatrixSizeListForType (e_BarCType eBCType)
 Returns implemented Data Matrix symbol sizes for given barcode type. Returns all possible Data Matrix symbol sizes for given barcode type in an array.
Remarks:
Background: Some barcode types base on Data Matrix (e.g. CMDM Mailmark) but use only a subset of the sizes available for Data Matrix.
If barcode type does not base on Data Matrix an empty list is returned.
See also:
BCGetDataMatrixSizesCount()
Return values:
e_DMSizes   * array of size enumerations (size is available via BCGetDataMatrixSizesCountExt()) ----------------------------------------------------------------------------.


LONG BCGetDataMatrixSizesCount ()
 Returns the number of supported Data Matrix symbol-sizes. Returns the number of possible symbol sizes for Data Matrix.
See also:
BCGetDataMatrixSizes()
Return values:
LONG   Number of supported Data Matrix symbol sizes ----------------------------------------------------------------------------.


LONG BCGetDataMatrixSizesCountForType (e_BarCType eBCType)
 Returns the number of supported Data Matrix symbol-sizes for of given barcode type. Returns the number of possible symbol sizes for Data Matrix for given barcode type.
Remarks:
Background: Some barcode types base on Data Matrix (e.g. CMDM Mailmark) but use only a subset of the sizes available for Data Matrix.
If barcode type does not base on Data Matrix '0' is returned.
See also:
BCGetDataMatrixSizes()
Return values:
LONG   Number of supported Data Matrix symbol sizes ----------------------------------------------------------------------------.


BOOL BC_DM_IsAppendAllowed (e_DMFormat eFormat)
 Returns if structured append is allowed depending on given format. Returns: TRUE if append is allowed, otherwise FALSE.

Detailed Description

Public API functions for Data Matrix.

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_DMSizes * BCGetDataMatrixSizeListForType ( e_BarCType eBCType )

Returns implemented Data Matrix symbol sizes for given barcode type. Returns all possible Data Matrix symbol sizes for given barcode type in an array.

Remarks:
Background: Some barcode types base on Data Matrix (e.g. CMDM Mailmark) but use only a subset of the sizes available for Data Matrix.
If barcode type does not base on Data Matrix an empty list is returned.
See also:
BCGetDataMatrixSizesCount()
Return values:
e_DMSizes   * array of size enumerations (size is available via BCGetDataMatrixSizesCountExt()) ----------------------------------------------------------------------------.

LPCSTR * BCGetDataMatrixSizesA ( )

Returns implemented Data Matrix symbol sizes. Returns all possible Data Matrix symbol-sizes in an array.

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

LONG BCGetDataMatrixSizesCount ( )

Returns the number of supported Data Matrix symbol-sizes. Returns the number of possible symbol sizes for Data Matrix.

See also:
BCGetDataMatrixSizes()
Return values:
LONG   Number of supported Data Matrix symbol sizes ----------------------------------------------------------------------------.

LONG BCGetDataMatrixSizesCountForType ( e_BarCType eBCType )

Returns the number of supported Data Matrix symbol-sizes for of given barcode type. Returns the number of possible symbol sizes for Data Matrix for given barcode type.

Remarks:
Background: Some barcode types base on Data Matrix (e.g. CMDM Mailmark) but use only a subset of the sizes available for Data Matrix.
If barcode type does not base on Data Matrix '0' is returned.
See also:
BCGetDataMatrixSizes()
Return values:
LONG   Number of supported Data Matrix symbol sizes ----------------------------------------------------------------------------.

LPCWSTR * BCGetDataMatrixSizesW ( )

Returns implemented Data Matrix symbol sizes. Returns all possible Data Matrix symbol-sizes in an array.

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

LONG BCGet_DM_AppendFileID ( t_BarCode * pBarCode )

Gets the adjusted File-ID in Data Matrix Structured Append mode. Returns currently adjusted value.

See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
LONG   Otherwise ----------------------------------------------------------------------------.

LONG BCGet_DM_AppendIndex ( t_BarCode * pBarCode )

Gets the current index of the symbol in Data Matrix Structured Append mode. Returns currently adjusted value.

See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
1..16   ] Otherwise ----------------------------------------------------------------------------.

LONG BCGet_DM_AppendSum ( t_BarCode * pBarCode )

Gets the adjusted total number of symbols in Data Matrix Structured Append mode. Returns currently adjusted value

See also:
BCSet_DM_Append() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No Structured Append. This is the default
2..16   ] Otherwise ----------------------------------------------------------------------------.

BOOL BCGet_DM_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_DM_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_DMFormat BCGet_DM_Format ( t_BarCode * pBarCode )

Gets the current Data Matrix Encoding Format. Returns currently adjusted value

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

BOOL BCGet_DM_Rectangular ( t_BarCode * pBarCode )

Gets if rectangular Data Matrix sizes are preferred. Returns currently adjusted value.

See also:
BCSet_DM_Rectangular() \param[in] pBarCode Pointer to barcode structure.
Return values:
false   Square sizes are preferred. This is the default
true   Rectangular sizes are preferred. ----------------------------------------------------------------------------.

e_DMSizes BCGet_DM_Size ( t_BarCode * pBarCode )

Gets currently adjusted Data Matrix symbol size. Returns currently adjusted value.

See also:
BCSet_DM_Size() \param[in] pBarCode Pointer to barcode structure.
Return values:
eDMSz_Default   No value set. This is the default (TBarCode determines the optimal symbol size automatically)
e_DMSizes   Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_DM_Append ( t_BarCode * pBarCode,
LONG nSum,
LONG nIndex,
LONG nFileID )

Activates Data Matrix "Structured Append" mode. Data Matrix 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. This function sets the total number of symbols and the index of the actual Data Matrix 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. Default: Standard Structured Append is used.

Note:
All symbols within a symbol chain must be identified by a unique File-ID.
See also:
BCGet_DM_AppendSum(), BCGet_DM_AppendIndex(), BCGet_DM_AppendFileID() \param[in] pBarCode Pointer to barcode structure. \param[in] nSum Number of symbols [2..16] (reset to default/disable = -1). \param[in] nIndex Index of symbol [1..16]. \param[in] nFileID File ID (must be the same in all symbols).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_DM_EnforceBinaryEncoding ( t_BarCode * pBarCode,
BOOL bEnforceBinary )

Determines whether Data Matrix shall be encoded in binary mode or not.

Note:
Binary mode usually is faster but produces bigger symbols than text mode
See also:
BCGet_DM_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_DM_Format ( t_BarCode * pBarCode,
e_DMFormat eFormat )

Specifies Data Matrix encoding format. Specifies the generated code format. Per default TBarCode uses the default encoding scheme.

See also:
BCGet_DM_Format() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Data Matrix format.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_DM_Rectangular ( t_BarCode * pBarCode,
BOOL bRect )

Switches between square or rectangular Data Matrix symbols. Per default TBarCode computes square Data Matrix symbols. Change this behavior with this function.

See also:
BCGet_DM_Rectangular() BCSet_DM_Size() \param[in] pBarCode Pointer to barcode structure. \param[in] bRect Rectangular symbols preferred. - true: Generate rectangular symbols - false: Generate square symbols (this is the default)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_DM_Size ( t_BarCode * pBarCode,
e_DMSizes eSize )

Sets Data Matrix symbol size. Specifies the size of the symbol. The size is given in rows and columns and can be between 10 x 10 and 144 x 144 for squares or 8 x 18 and 26 x 64 for rectangles. The Data Matrix Rectangular Extension (DMRE) specifies the matrix range from 8 x 48 to 26 x 64.

Note:
Each matrix size has a limited data capacity. If the amount of data cannot be encoded with the selected matrix, an error will be raised. If no fixed size is selected TBarCode computes and selects the minimal required size of the symbol automatically.
See also:
BCGet_DM_Size() BCSet_DM_Rectangular() \param[in] pBarCode Pointer to barcode structure. \param[in] eSize Bar-code size enumerator.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

BOOL BC_DM_IsAppendAllowed ( e_DMFormat eFormat )

Returns if structured append is allowed depending on given format. Returns: TRUE if append is allowed, otherwise FALSE.

© 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