ratioapi.cpp File Reference


Functions

LPCSTR BCGetRatioString (e_BarCType eType)
 Returns the default print-ratio string of the barcode. Returns the default print-ratio of the selected barcode type as string. The ratio string looks like "1:3:1:3" where the single values separated by colons corresponds to the ratio-values of the bars or spaces. The format of the ratio-string matches the format of the ratio-hint (see BCGetRatioHint()). This default value is used if no other print-ratio was selected.
See also:
BCSetRatio(), BCGetRatioHint() \param[in] eType Barcode type.
Return values:
LPCSTR   Bar-code symbology depending string in the format "1:2:...:1:2" ----------------------------------------------------------------------------.


LPCSTR BCGetRatioHint (e_BarCType eType)
 Returns the format hint for the print-ratio. Return the format of the ratio-string (to be used only as hint for users or developers). This hint serves as template for your own print-ratio strings passed to BSSetRatio(). The value depends on the selected barcode symbology. Learn more about it in the Barcode Reference.
See also:
BCSetRatio(), BCGetRatio(), BCGetRatioString() \param[in] eType Barcode type.
Return values:
LPCSTR   Bar-code symbology depending string in the format "1B:2B:...:1S:2S" ----------------------------------------------------------------------------.


LONG BCGetCountBars (e_BarCType eBarCType)
 Returns number of different bar-widths used by the symbology. Returns number of different bar-widths used for the specified barcode symbology.
Code 2 of 5 Interleaved uses two different bar-widths: the return value is 2.
See also:
BCGetRatioHint(), BCSetRatio(), BCGetRatio(), BCGetCountSpaces() \param[in] eBarCType Bar-code type.
Return values:
-1   In case of error
>0   Otherwise ----------------------------------------------------------------------------.


LONG BCGetCountSpaces (e_BarCType eBarCType)
 Returns number of different space-widths used by the symbology. Returns number of different space-widths for specified barcode symbology.
Code 2 of 5 Interleaved uses two different space-widths: the return value is 2.
See also:
BCGetRatioHint(), BCSetRatio(), BCGetRatio(), BCGetCountBars() \param[in] eBarCType Bar-code type.
Return values:
-1   In case of error
>0   Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGetRatioA (t_BarCode* pBarCode)
 Gets current print-ratio string. Returns currently adjusted value.
See also:
BCSetRatio(), BCGetRatioHint(), BCGetRatioString() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCSTR   Current ratio-string in format similar to "1B:2B:...1S:2S" ----------------------------------------------------------------------------.


LPCWSTR BCGetRatioW (t_BarCode* pBarCode)
 Gets current print-ratio string. Returns currently adjusted value.
See also:
BCSetRatio(), BCGetRatioHint(), BCGetRatioString() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCSTR   Current ratio-string in format similar to "1B:2B:...1S:2S" ----------------------------------------------------------------------------.


ERRCODE BCSetRatioA (t_BarCode* pBarCode, LPCSTR szRatio)
 Set print-ratio string. Specifies the print-ratio string for the width-relationship of the single bars and spaces. A format template used for this string is available in the property RatioHint (see BCGetRatioHint()). The ratio string looks like "1B:2B:...1S:2S" where 1B stands for the ratio-value for the most narrow bar, 1S for the ratio-value of the most-narrow space. The number of values for bars (xB) and the number of values for the spaces (xS) depends on the current symbology. It is explained in more detail in the separate document Barcode Reference.
See also:
BCGetRatio(), BCGetRatioHint() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Print-ratio string in the form "1:2:...1:2" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSetRatioW (t_BarCode* pBarCode, LPCWSTR szRatio)
 Set print-ratio string. Specifies the print-ratio string for the width-relationship of the single bars and spaces. A format template used for this string is available in the property RatioHint (see BCGetRatioHint()). The ratio string looks like "1B:2B:...1S:2S" where 1B stands for the ratio-value for the most narrow bar, 1S for the ratio-value of the most-narrow space. The number of values for bars (xB) and the number of values for the spaces (xS) depends on the current symbology. It is explained in more detail in the separate document Barcode Reference.
See also:
BCGetRatio(), BCGetRatioHint() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Print-ratio string in the form "1:2:...1:2" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Function Documentation

LONG BCGetCountBars ( e_BarCType eBarCType )

Returns number of different bar-widths used by the symbology. Returns number of different bar-widths used for the specified barcode symbology.
Code 2 of 5 Interleaved uses two different bar-widths: the return value is 2.

See also:
BCGetRatioHint(), BCSetRatio(), BCGetRatio(), BCGetCountSpaces() \param[in] eBarCType Bar-code type.
Return values:
-1   In case of error
>0   Otherwise ----------------------------------------------------------------------------.

LONG BCGetCountSpaces ( e_BarCType eBarCType )

Returns number of different space-widths used by the symbology. Returns number of different space-widths for specified barcode symbology.
Code 2 of 5 Interleaved uses two different space-widths: the return value is 2.

See also:
BCGetRatioHint(), BCSetRatio(), BCGetRatio(), BCGetCountBars() \param[in] eBarCType Bar-code type.
Return values:
-1   In case of error
>0   Otherwise ----------------------------------------------------------------------------.

LPCSTR BCGetRatioA ( t_BarCode * pBarCode )

Gets current print-ratio string. Returns currently adjusted value.

See also:
BCSetRatio(), BCGetRatioHint(), BCGetRatioString() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCSTR   Current ratio-string in format similar to "1B:2B:...1S:2S" ----------------------------------------------------------------------------.

LPCSTR BCGetRatioHint ( e_BarCType eType )

Returns the format hint for the print-ratio. Return the format of the ratio-string (to be used only as hint for users or developers). This hint serves as template for your own print-ratio strings passed to BSSetRatio(). The value depends on the selected barcode symbology. Learn more about it in the Barcode Reference.

See also:
BCSetRatio(), BCGetRatio(), BCGetRatioString() \param[in] eType Barcode type.
Return values:
LPCSTR   Bar-code symbology depending string in the format "1B:2B:...:1S:2S" ----------------------------------------------------------------------------.

LPCSTR BCGetRatioString ( e_BarCType eType )

Returns the default print-ratio string of the barcode. Returns the default print-ratio of the selected barcode type as string. The ratio string looks like "1:3:1:3" where the single values separated by colons corresponds to the ratio-values of the bars or spaces. The format of the ratio-string matches the format of the ratio-hint (see BCGetRatioHint()). This default value is used if no other print-ratio was selected.

See also:
BCSetRatio(), BCGetRatioHint() \param[in] eType Barcode type.
Return values:
LPCSTR   Bar-code symbology depending string in the format "1:2:...:1:2" ----------------------------------------------------------------------------.

LPCWSTR BCGetRatioW ( t_BarCode * pBarCode )

Gets current print-ratio string. Returns currently adjusted value.

See also:
BCSetRatio(), BCGetRatioHint(), BCGetRatioString() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCSTR   Current ratio-string in format similar to "1B:2B:...1S:2S" ----------------------------------------------------------------------------.

ERRCODE BCSetRatioA ( t_BarCode * pBarCode,
LPCSTR szRatio )

Set print-ratio string. Specifies the print-ratio string for the width-relationship of the single bars and spaces. A format template used for this string is available in the property RatioHint (see BCGetRatioHint()). The ratio string looks like "1B:2B:...1S:2S" where 1B stands for the ratio-value for the most narrow bar, 1S for the ratio-value of the most-narrow space. The number of values for bars (xB) and the number of values for the spaces (xS) depends on the current symbology. It is explained in more detail in the separate document Barcode Reference.

See also:
BCGetRatio(), BCGetRatioHint() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Print-ratio string in the form "1:2:...1:2" (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSetRatioW ( t_BarCode * pBarCode,
LPCWSTR szRatio )

Set print-ratio string. Specifies the print-ratio string for the width-relationship of the single bars and spaces. A format template used for this string is available in the property RatioHint (see BCGetRatioHint()). The ratio string looks like "1B:2B:...1S:2S" where 1B stands for the ratio-value for the most narrow bar, 1S for the ratio-value of the most-narrow space. The number of values for bars (xB) and the number of values for the spaces (xS) depends on the current symbology. It is explained in more detail in the separate document Barcode Reference.

See also:
BCGetRatio(), BCGetRatioHint() \param[in] pBarCode Pointer to barcode structure. \param[in] szRatio Print-ratio string in the form "1:2:...1:2" (reset to default = null).
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