aztecapi.cpp File Reference

Functions

Gets currently adjusted Aztec Code symbol size. Returns currently adjusted value.
See also:
BCSet_Aztec_Size() \param[in] pBarCode Pointer to barcode structure.
Return values:

eAztecSz_Default No value set. This is the default (TBarCode determines the optimal symbol size automatically)

e_AztecSizes Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_Aztec_Size (t_BarCode* pBarCode, e_AztecSizes eSize)

Sets Aztec Code symbol size. Specifies the size of the symbol. The size is given in rows and columns and can be between 15 x 15 and 151 x 151. If no fixed size is selected TBarCode computes the minimal required size of the symbol automatically.
Note:
The sizes eAztecSz_19x19_Rd, eAztecSz_23x23_Rd, eAztecSz_27x27_Rd are specially used for reader programming
See also:
BCGet_Aztec_Size() \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

BCGet_Aztec_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_Aztec_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_Aztec_EnforceBinaryEncoding (t_BarCode* pBarCode, BOOL bEnforceBinary)

Determines whether Aztec Code shall be encoded in binary mode or not.
Note:
Binary mode usually is faster but produces bigger symbols than text mode
See also:
BCGet_Aztec_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. ----------------------------------------------------------------------------.

BOOL

BCGet_Aztec_RuneMode (t_BarCode* pBarCode)

Determines whether the symbol is in Aztec Rune Mode. Returns currently adjusted value
See also:
BCSet_Aztec_RuneMode() \param[in] pBarCode Pointer to barcode structure.
Return values:

TRUE symbol is in Aztec Rune mode (numbers from 0 to 255)

FALSE symbol is in Aztec Code mode ----------------------------------------------------------------------------.

ERRCODE

BCSet_Aztec_RuneMode (t_BarCode* pBarCode, BOOL bRuneMode)

Determines whether symbol shall be encoded in Aztec Rune mode.
Note:
Aztec Runes are special Aztec Codes without data section.
Aztec Runes can encode values from 0 to 255
See also:
BCGet_Aztec_RuneMode() \param[in] pBarCode Pointer to barcode structure. \param[in] bRuneMode activate Aztec Rune mode (TRUE) or deactivate it (FALSE)
Return values:

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

LONG

BCGet_Aztec_ErrorCorrection (t_BarCode* pBarCode)

Gets the number of error correction codewords in percent of the symbol size Returns currently adjusted value
See also:
BCSet_Aztec_ErrorCorrection() \param[in] pBarCode Pointer to barcode structure.
Return values:

0..99

FALSE data is encoded in mixed (=text and binary) format ----------------------------------------------------------------------------.

ERRCODE

BCSet_Aztec_ErrorCorrection (t_BarCode* pBarCode, LONG nErrorCorrection)

Sets the number of error correction codewords in percent (from 0 to 99) of the symbol size.
Note:
By default the error correction level is 23%.
3 additional check words are added for error detection.
See also:
BCGet_Aztec_ErrorCorrection() \param[in] pBarCode Pointer to barcode structure. \param[in] nErrorCorrection level of error correction in percent (default is 23).
Return values:

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

e_AztecFormat

BCGet_Aztec_Format (t_BarCode* pBarCode)

Gets the current Aztec Code Encoding Format. Returns currently adjusted value
See also:
BCSet_Aztec_Format() \param[in] pBarCode Pointer to barcode structure.
Return values:

eAztecFm_Default This is the default

e_AztecFormat Otherwise ----------------------------------------------------------------------------.

LPCSTR

BCGet_Aztec_FormatSpecifierA (t_BarCode* pBarCode)

Gets the current Aztec Code Encoding Format specifier for industry format. Returns currently adjusted value
See also:
BCSet_Aztec_Format() \param[in] pBarCode Pointer to barcode structure.
Return values:

\0 No format specifier. This is the default

LPCSTR Otherwise ----------------------------------------------------------------------------.

LPCWSTR

BCGet_Aztec_FormatSpecifierW (t_BarCode* pBarCode)

ERRCODE

BCSet_Aztec_FormatA (t_BarCode* pBarCode, e_AztecFormat eFormat, LPCSTR szFormatSpecifier)

Specifies Aztec Code encoding format. Specifies the encoding format (standard, GS1 or industry). Default is eAztecFm_Default (standard format).
See also:
BCGet_Aztec_Format(), BCGet_Aztec_FormatSpecifier() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Aztec Code format. \param[in] szFormatSpecifier Format specifier for industry format. Consist of 1 letter (upper or lower) or 2 digits. This parameter is ignored for other code formats.
Return values:

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

ERRCODE

BCSet_Aztec_FormatW (t_BarCode* pBarCode, e_AztecFormat eFormat, LPCWSTR szFormatSpecifier)

BOOL

BCGet_Aztec_AppendActive (t_BarCode* pBarCode)

Determines whether the structured append mode is active. Returns TRUE if structured append mode is active, otherwise FALSE
See also:
BCSet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure.
Return values:

TRUE if structured append mode is active

FALSE if structured append mode is inactive (default) ----------------------------------------------------------------------------.

CHAR

BCGet_Aztec_AppendTotalA (t_BarCode* pBarCode)

Gets the adjusted total number of symbols in the Aztec Code Structured Append mode. Returns currently adjusted value
See also:
BCSet_Aztec_AppendData() \param[in] pBarCode Pointer to barcode structure.
Return values:

A '..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

WCHAR

BCGet_Aztec_AppendTotalW (t_BarCode* pBarCode)

CHAR

BCGet_Aztec_AppendIndexA (t_BarCode* pBarCode)

Gets the current index of the symbol in Aztec Code Structured Append mode. Returns currently adjusted value.
See also:
BCSet_Aztec_AppendData() \param[in] pBarCode Pointer to barcode structure.
Return values:

A '..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

WCHAR

BCGet_Aztec_AppendIndexW (t_BarCode* pBarCode)

LPCSTR

BCGet_Aztec_AppendMessageIDA (t_BarCode* pBarCode)

Gets the adjusted Message-ID in Aztec Code Structured Append mode. Returns currently adjusted value.
See also:
BCSet_Aztec_AppendData() \param[in] pBarCode Pointer to barcode structure.
Return values:

NULL No Message-ID set. This is the default.

LPCSTR Otherwise ----------------------------------------------------------------------------.

LPCWSTR

BCGet_Aztec_AppendMessageIDW (t_BarCode* pBarCode)

ERRCODE

BCSet_Aztec_AppendActive (t_BarCode* pBarCode, BOOL bActivate)

Activates/Deactivates Aztec Code "Structured Append" mode. To set the data for structurer Aztec 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. This function activates or deactivates the structured append mode. To change the structured append data use function BCSet_Aztec_AppendData. 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:
To change the settings of structured append mode call function BCSet_Aztec_AppendData.
See also:
BCSet_Aztec_AppendData(), BCGet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure. \param[in] bActivate Determines if structured append mode should be activated (with TRUE) or deactivated (with FALSE)
Return values:

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

ERRCODE

BCSet_Aztec_AppendDataA (t_BarCode* pBarCode, CHAR cTotal, CHAR cIndex, LPCSTR szMessageID)

Sets Aztec Code "Structured Append" data. This function sets the total number of symbols and the index of the actual Aztec 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. Default: Standard Structured Append is used.
Note:
To use structured append mode it must be activated by calling the function BCSet_Aztec_AppendActive.
If a Message-ID is used, all symbols within a symbol chain must have the same one.
See also:
BCGet_Aztec_AppendTotal(), BCGet_Aztec_AppendIndex(), BCGet_Aztec_AppendMessageID(), BCSet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure. \param[in] cTotal Total number of symbols 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] cIndex Index of current symbol 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] szMessageID Message ID [optional] (must be NULL or the same in all symbols).
Return values:

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

ERRCODE

BCSet_Aztec_AppendDataW (t_BarCode* pBarCode, WCHAR cTotal, WCHAR cIndex, LPCWSTR szMessageID)

LPCSTR*

BCGetAztecSizesA ()

Returns the implemented Aztec Code symbol sizes. Returns all possible Aztec Code symbol sizes in an array.
See also:
BCGetAztecSizesCount()
Return values:

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

LPCWSTR*

BCGetAztecSizesW ()

LONG

BCGetAztecSizesCount ()

Returns the number of supported Aztec Code symbol-sizes. Returns the number of possible symbol sizes for Aztec Code.
See also:
BCGetAztecSizes()
Return values:

LONG Number of supported Aztec Code symbol sizes ----------------------------------------------------------------------------.

Detailed Description

Function Documentation

Returns the implemented Aztec Code symbol sizes. Returns all possible Aztec Code symbol sizes in an array.

See also:: BCGetAztecSizesCount()

Return values:

LPCSTR

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

Returns the number of supported Aztec Code symbol-sizes. Returns the number of possible symbol sizes for Aztec Code.

See also:: BCGetAztecSizes()

Return values:

LONG

Number of supported Aztec Code symbol sizes ----------------------------------------------------------------------------.

Returns the implemented Aztec Code symbol sizes. Returns all possible Aztec Code symbol sizes in an array.

See also:: BCGetAztecSizesCount()

Return values:

LPCSTR

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

Determines whether the structured append mode is active. Returns TRUE if structured append mode is active, otherwise FALSE

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

Return values:

TRUE	if structured append mode is active
FALSE	if structured append mode is inactive (default) ----------------------------------------------------------------------------.

Gets the current index of the symbol in Aztec Code Structured Append mode. Returns currently adjusted value.

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

Return values:

A	'..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

Gets the current index of the symbol in Aztec Code Structured Append mode. Returns currently adjusted value.

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

Return values:

A	'..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

Gets the adjusted Message-ID in Aztec Code Structured Append mode. Returns currently adjusted value.

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

Return values:

NULL	No Message-ID set. This is the default.
LPCSTR	Otherwise ----------------------------------------------------------------------------.

Gets the adjusted Message-ID in Aztec Code Structured Append mode. Returns currently adjusted value.

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

Return values:

NULL	No Message-ID set. This is the default.
LPCSTR	Otherwise ----------------------------------------------------------------------------.

Gets the adjusted total number of symbols in the Aztec Code Structured Append mode. Returns currently adjusted value

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

Return values:

A	'..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

Gets the adjusted total number of symbols in the Aztec Code Structured Append mode. Returns currently adjusted value

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

Return values:

A	'..'Z'] which means 1..26. The default value is 'A'. ----------------------------------------------------------------------------.

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

See also:: BCSet_Aztec_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 ----------------------------------------------------------------------------.

Gets the number of error correction codewords in percent of the symbol size Returns currently adjusted value

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

Return values:

0..99
FALSE	data is encoded in mixed (=text and binary) format ----------------------------------------------------------------------------.

Gets the current Aztec Code Encoding Format. Returns currently adjusted value

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

Return values:

eAztecFm_Default	This is the default
e_AztecFormat	Otherwise ----------------------------------------------------------------------------.

Gets the current Aztec Code Encoding Format specifier for industry format. Returns currently adjusted value

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

Return values:

\0	No format specifier. This is the default
LPCSTR	Otherwise ----------------------------------------------------------------------------.

Gets the current Aztec Code Encoding Format specifier for industry format. Returns currently adjusted value

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

Return values:

\0	No format specifier. This is the default
LPCSTR	Otherwise ----------------------------------------------------------------------------.

Determines whether the symbol is in Aztec Rune Mode. Returns currently adjusted value

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

Return values:

TRUE	symbol is in Aztec Rune mode (numbers from 0 to 255)
FALSE	symbol is in Aztec Code mode ----------------------------------------------------------------------------.

Gets currently adjusted Aztec Code symbol size. Returns currently adjusted value.

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

Return values:

eAztecSz_Default	No value set. This is the default (TBarCode determines the optimal symbol size automatically)
e_AztecSizes	Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_Aztec_AppendActive ( t_BarCode * pBarCode,

BOOL bActivate )

Note:: To change the settings of structured append mode call function BCSet_Aztec_AppendData.

See also:: BCSet_Aztec_AppendData(), BCGet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure. \param[in] bActivate Determines if structured append mode should be activated (with TRUE) or deactivated (with FALSE)

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_AppendDataA ( t_BarCode * pBarCode,

CHAR cTotal,

CHAR cIndex,

LPCSTR szMessageID )

Note:: To use structured append mode it must be activated by calling the function BCSet_Aztec_AppendActive.; If a Message-ID is used, all symbols within a symbol chain must have the same one.

See also:: BCGet_Aztec_AppendTotal(), BCGet_Aztec_AppendIndex(), BCGet_Aztec_AppendMessageID(), BCSet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure. \param[in] cTotal Total number of symbols 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] cIndex Index of current symbol 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] szMessageID Message ID [optional] (must be NULL or the same in all symbols).

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_AppendDataW ( t_BarCode * pBarCode,

WCHAR cTotal,

WCHAR cIndex,

LPCWSTR szMessageID )

Note:: To use structured append mode it must be activated by calling the function BCSet_Aztec_AppendActive.; If a Message-ID is used, all symbols within a symbol chain must have the same one.

See also:: BCGet_Aztec_AppendTotal(), BCGet_Aztec_AppendIndex(), BCGet_Aztec_AppendMessageID(), BCSet_Aztec_AppendActive() \param[in] pBarCode Pointer to barcode structure. \param[in] cTotal Total number of symbols 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] cIndex Index of current symbol 'A'..'Z', with 'A'=1 and 'Z'=26. \param[in] szMessageID Message ID [optional] (must be NULL or the same in all symbols).

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_EnforceBinaryEncoding ( t_BarCode * pBarCode,

BOOL bEnforceBinary )

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

Note:: Binary mode usually is faster but produces bigger symbols than text mode

See also:: BCGet_Aztec_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_Aztec_ErrorCorrection ( t_BarCode * pBarCode,

LONG nErrorCorrection )

Sets the number of error correction codewords in percent (from 0 to 99) of the symbol size.

Note:: By default the error correction level is 23%.; 3 additional check words are added for error detection.

See also:: BCGet_Aztec_ErrorCorrection() \param[in] pBarCode Pointer to barcode structure. \param[in] nErrorCorrection level of error correction in percent (default is 23).

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_FormatA ( t_BarCode * pBarCode,

e_AztecFormat eFormat,

LPCSTR szFormatSpecifier )

Specifies Aztec Code encoding format. Specifies the encoding format (standard, GS1 or industry). Default is eAztecFm_Default (standard format).

See also:: BCGet_Aztec_Format(), BCGet_Aztec_FormatSpecifier() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Aztec Code format. \param[in] szFormatSpecifier Format specifier for industry format. Consist of 1 letter (upper or lower) or 2 digits. This parameter is ignored for other code formats.

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_FormatW ( t_BarCode * pBarCode,

e_AztecFormat eFormat,

LPCWSTR szFormatSpecifier )

Specifies Aztec Code encoding format. Specifies the encoding format (standard, GS1 or industry). Default is eAztecFm_Default (standard format).

See also:: BCGet_Aztec_Format(), BCGet_Aztec_FormatSpecifier() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Aztec Code format. \param[in] szFormatSpecifier Format specifier for industry format. Consist of 1 letter (upper or lower) or 2 digits. This parameter is ignored for other code formats.

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_RuneMode ( t_BarCode * pBarCode,

BOOL bRuneMode )

Determines whether symbol shall be encoded in Aztec Rune mode.

Note:: Aztec Runes are special Aztec Codes without data section.; Aztec Runes can encode values from 0 to 255

See also:: BCGet_Aztec_RuneMode() \param[in] pBarCode Pointer to barcode structure. \param[in] bRuneMode activate Aztec Rune mode (TRUE) or deactivate it (FALSE)

Return values:

ERRCODE

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

ERRCODE BCSet_Aztec_Size ( t_BarCode * pBarCode,

e_AztecSizes eSize )

Note:: The sizes eAztecSz_19x19_Rd, eAztecSz_23x23_Rd, eAztecSz_27x27_Rd are specially used for reader programming

See also:: BCGet_Aztec_Size() \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. ----------------------------------------------------------------------------.

� 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