compsymapi.cpp File Reference

Public API functions for Composite Symbols. More...


Functions

e_CCType BCGet2DCompositeComponent (t_BarCode* pBarCode)
 Gets adjusted 2D Composite Component. Returns currently adjusted CC.
See also:
BCSet2DCompositeComponent() \param[in] pBarCode Pointer to barcode structure.
Return values:
eCC_None   No value set. This is the default
e_CCType   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet2DCompositeComponent (t_BarCode* pBarCode, e_CCType eCCType)
 Sets 2D Composite Component (= CC) Type. Enables or disables generation of an GS1 Composite Symbology and adjusts the type of the 2D composite component (CC-A, CC-B or CC-C). The CC is printed on top of the base symbol, which can be an GS1 DataBar or an EAN-128 symbology. For usual applications (using GS1 Composite) we recommend to set the CC-Type to eCC_Auto. In this case TBarCode computes the optimal CC automatically. Default: eCC_None.
See also:
BCGet2DCompositeComponent() \param[in] pBarCode Pointer to barcode structure. \param[in] eCCType CC Type.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


BOOL BCGet_CompSym_IsCCPresent (t_BarCode* pBarCode)
 Determines if a composite component was created. After BCCreate() you can check if a composite component is present (and therefore is part of the created symbol). This method is useful if you adjusted a composite component to be created but - depending on missing input data - the composite component may be omitted (only the linear bar code appears).
Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure.
Return values:
true   A composite component was created
false   No composite component was created ----------------------------------------------------------------------------.


BOOL BCGet_CompSym_IsCCAvailable (t_BarCode* pBarCode, e_CCType eCCType)
 Check if a composite component is available for the current base symbology. Used with GS1 Composite Symbology. Tells you if a specific 2D composite component (CC-A/B/C) can be combined with the selected base symbology. Adjust the base symbology first with BCSetBCType(). \param[in] pBarCode Pointer to barcode structure. \param[in] eCCType Composite component type (symbology of composite component).
Return values:
true   The specified composite component is available
false   The specified composite component is not available ----------------------------------------------------------------------------.


BOOL BCGet_CompSym_ErrorInCC (t_BarCode* pBarCode)
 Determines the source of the error when creating composite symbologies. If BCCreate() returns with an error this function indicates whether the error happened in the base symbology or in the composite symbol. Example: If the composite component could not be created due to wrong data this function returns true. \param[in] pBarCode Pointer to barcode structure.
Return values:
true   Error occurred during creation of the composite component
false   Error occurred during creation of the base symbology ----------------------------------------------------------------------------.


BOOL BCIsCompositeAllowed (e_BarCType barcodeType)
 Retrieves whether the barcode type can be a composite barcode. Only certain types of barcodes can have composite components. You can use this function to find out if a certain barcode type supports a composite component. \param[in] barcodeType e_BarCType. The type of barcode.
Return values:
true   The given barcode type supports a composite component.
false   The given barcode type cannot be a composite barcode. --------------------------------------------------------------------------.


BOOL BCIsCompositeComponentAllowed (e_BarCType barcodeType, e_CCType componentType)
 Retrieves whether the barcode type can be a composite barcode with a certain component. Only certain types of barcodes can have composite components, and not all composite barcodes support all type of component types. You can use this function to find out if a certain barcode type supports a certain type of composite component. \param[in] barcodeType e_BarCType. The type of barcode. \param[in] componentType e_CCType. The type of composite component.
Return values:
true   The given barcode type supports the given composite component.
false   The given barcode type cannot be a composite barcode, or it the does not support the given type of component. --------------------------------------------------------------------------.


Detailed Description

Public API functions for Composite Symbols.

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_CCType BCGet2DCompositeComponent ( t_BarCode * pBarCode )

Gets adjusted 2D Composite Component. Returns currently adjusted CC.

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

BOOL BCGet_CompSym_ErrorInCC ( t_BarCode * pBarCode )

Determines the source of the error when creating composite symbologies. If BCCreate() returns with an error this function indicates whether the error happened in the base symbology or in the composite symbol. Example: If the composite component could not be created due to wrong data this function returns true. \param[in] pBarCode Pointer to barcode structure.

Return values:
true   Error occurred during creation of the composite component
false   Error occurred during creation of the base symbology ----------------------------------------------------------------------------.

BOOL BCGet_CompSym_IsCCAvailable ( t_BarCode * pBarCode,
e_CCType eCCType )

Check if a composite component is available for the current base symbology. Used with GS1 Composite Symbology. Tells you if a specific 2D composite component (CC-A/B/C) can be combined with the selected base symbology. Adjust the base symbology first with BCSetBCType(). \param[in] pBarCode Pointer to barcode structure. \param[in] eCCType Composite component type (symbology of composite component).

Return values:
true   The specified composite component is available
false   The specified composite component is not available ----------------------------------------------------------------------------.

BOOL BCGet_CompSym_IsCCPresent ( t_BarCode * pBarCode )

Determines if a composite component was created. After BCCreate() you can check if a composite component is present (and therefore is part of the created symbol). This method is useful if you adjusted a composite component to be created but - depending on missing input data - the composite component may be omitted (only the linear bar code appears).

Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure.
Return values:
true   A composite component was created
false   No composite component was created ----------------------------------------------------------------------------.

BOOL BCIsCompositeAllowed ( e_BarCType barcodeType )

Retrieves whether the barcode type can be a composite barcode. Only certain types of barcodes can have composite components. You can use this function to find out if a certain barcode type supports a composite component. \param[in] barcodeType e_BarCType. The type of barcode.

Return values:
true   The given barcode type supports a composite component.
false   The given barcode type cannot be a composite barcode. --------------------------------------------------------------------------.

BOOL BCIsCompositeComponentAllowed ( e_BarCType barcodeType,
e_CCType componentType )

Retrieves whether the barcode type can be a composite barcode with a certain component. Only certain types of barcodes can have composite components, and not all composite barcodes support all type of component types. You can use this function to find out if a certain barcode type supports a certain type of composite component. \param[in] barcodeType e_BarCType. The type of barcode. \param[in] componentType e_CCType. The type of composite component.

Return values:
true   The given barcode type supports the given composite component.
false   The given barcode type cannot be a composite barcode, or it the does not support the given type of component. --------------------------------------------------------------------------.

ERRCODE BCSet2DCompositeComponent ( t_BarCode * pBarCode,
e_CCType eCCType )

Sets 2D Composite Component (= CC) Type. Enables or disables generation of an GS1 Composite Symbology and adjusts the type of the 2D composite component (CC-A, CC-B or CC-C). The CC is printed on top of the base symbol, which can be an GS1 DataBar or an EAN-128 symbology. For usual applications (using GS1 Composite) we recommend to set the CC-Type to eCC_Auto. In this case TBarCode computes the optimal CC automatically. Default: eCC_None.

See also:
BCGet2DCompositeComponent() \param[in] pBarCode Pointer to barcode structure. \param[in] eCCType CC Type.
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