cbfapi.cpp File Reference

Functions

LONG

Gets the adjusted number of Codablock-F rows. Returns currently adjusted value.
See also:
BCSet_CBF_Rows() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

2..44 ] Otherwise ----------------------------------------------------------------------------.

LONG

BCGet_CBF_Columns (t_BarCode* pBarCode)

Gets the number of adjusted Codablock-F columns. Returns currently adjusted value.
See also:
BCSet_CBF_Columns() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

4..62 ] Otherwise ----------------------------------------------------------------------------.

LONG

BCGet_CBF_RowHeight (t_BarCode* pBarCode)

Gets the adjusted row height for Codablock-F. Returns currently adjusted value.
See also:
BCSet_CBF_RowHeight() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

LONG Row height [1/1000 mm] ----------------------------------------------------------------------------.

LONG

BCGet_CBF_RowSeparatorHeight (t_BarCode* pBarCode)

Gets the currently adjusted row separator height for Codablock-F. Returns currently adjusted value.
See also:
BCSet_CBF_RowSeparatorHeight() \param[in] pBarCode Pointer to barcode structure.
Return values:

-1 No value set. This is the default

LONG Row separator height [1/1000 mm] ----------------------------------------------------------------------------.

e_CBFFormat

BCGet_CBF_Format (t_BarCode* pBarCode)

Gets the adjusted Codablock-F code format. Returns currently adjusted value.
See also:
BCSet_CBF_Format() \param[in] pBarCode Pointer to barcode structure.
Return values:

eCBFPr_Default No value set. This is the default

e_CBFFormat Otherwise ----------------------------------------------------------------------------.

ERRCODE

BCSet_CBF_Rows (t_BarCode* pBarCode, LONG nRows )

Adjusts the number of CodaBlock-F rows. Specifies the number of rows that should be used for the CodaBlock-F symbol. If this value is not set explicitly, TBarCode computes the number of rows automatically (default).
See also:
BCGet_CBF_Rows() \param[in] pBarCode Pointer to barcode structure. \param[in] nRows Number of rows [2..44] (-1 ... reset to default).
Return values:

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

ERRCODE

BCSet_CBF_Columns (t_BarCode* pBarCode, LONG nColumns)

Adjusts the number of Codablock-F columns. Specifies the number of columns that should be used for the Codablock-F symbol. If this value is not set explicitly, TBarCode computes the number of columns automatically (default).
See also:
BCGet_CBF_Columns() \param[in] pBarCode Pointer to barcode structure. \param[in] nColumns Number of columns [4..62] (-1 ... reset to default).
Return values:

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

ERRCODE

BCSet_CBF_RowHeight (t_BarCode* pBarCode, LONG nHeight)

Sets the row height for Codablock-F. Specifies the height of an individual row in 1/1000 mm. If this value is not set explicitly (=default), the height is calculated according to the bounding rectangle when drawing (see BCDraw()). If set, ensure that the bounding rectangle is big enough to avoid clipping.
See also:
BCGet_CBF_RowHeight() \param[in] pBarCode Pointer to barcode structure. \param[in] nHeight Row height [1/1000 mm] (-1 ... reset to default).
Return values:

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

ERRCODE

BCSet_CBF_RowSeparatorHeight (t_BarCode* pBarCode, LONG nHeight)

Sets the height of the Codablock-F row-separator. Specifies the height of the row-separator in 1/1000 mm. If this value is not set (=default), the height of the separator row is calculated automatically (according to the bounding rectangle). If set, ensure that the bounding rectangle is big enough to avoid clipping.
See also:
BCGet_CBF_RowSeparatorHeight() \param[in] pBarCode Pointer to barcode structure. \param[in] nHeight Row separator height [1/1000 mm] (-1 ... reset to default).
Return values:

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

ERRCODE

BCSet_CBF_Format (t_BarCode* pBarCode, e_CBFFormat eFormat)

Sets Codablock-F code format. Specifies the encoding format for Codablock-F. Selects UCC/EAN or the default encoding format.
See also:
BCGet_CBF_Format() \param[in] pBarCode Pointer to barcode structure. \param[in] eFormat Codablock F format.
Return values:

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

Detailed Description

Function Documentation

Gets the number of adjusted Codablock-F columns. Returns currently adjusted value.

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

Return values:

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

Gets the adjusted Codablock-F code format. Returns currently adjusted value.

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

Return values:

eCBFPr_Default	No value set. This is the default
e_CBFFormat	Otherwise ----------------------------------------------------------------------------.

Gets the adjusted row height for Codablock-F. Returns currently adjusted value.

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

Return values:

-1	No value set. This is the default
LONG	Row height [1/1000 mm] ----------------------------------------------------------------------------.

Gets the currently adjusted row separator height for Codablock-F. Returns currently adjusted value.

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

Return values:

-1	No value set. This is the default
LONG	Row separator height [1/1000 mm] ----------------------------------------------------------------------------.

Gets the adjusted number of Codablock-F rows. Returns currently adjusted value.

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

Return values:

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

ERRCODE BCSet_CBF_Columns ( t_BarCode * pBarCode,

LONG nColumns )

See also:: BCGet_CBF_Columns() \param[in] pBarCode Pointer to barcode structure. \param[in] nColumns Number of columns [4..62] (-1 ... reset to default).

Return values:

ERRCODE