quietapi.cpp File Reference


Functions

const LPRECTD BCGetQuietZone (t_BarCode* pBarCode)
 Gets current quiet-zone settings. Returns currently adjusted value.
See also:
BCSetQuietZone() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCRECT   rectangle specifying the quiet-zone dimensions [modules]. ----------------------------------------------------------------------------.


e_MUnit BCGetQuietZoneUnit (t_BarCode* pBarCode)
 Gets current measurement unit used for specifying quiet-zones. Returns currently adjusted value.
See also:
BCSetQuietZone() \param[in] pBarCode Pointer to barcode structure.
Return values:
e_QZMUnit   Unit enumerator. ----------------------------------------------------------------------------.


ERRCODE BCSetQuietZone (t_BarCode* pBarCode, LPRECTD prQuietZone, e_MUnit eQZUnit)
 Sets the size of the quiet-zones in given units. Specifies the size of the required quiet zone in the respective units. A quiet zone is an unprinted area above, below, right, or left of a barcode.
Note:
If you specify the quiet zone in modules, the width of the quiet zone depends on the module width (respectively “narrow bar width X”). \param[in] pBarCode Pointer to barcode structure. \param[in] prQuietZone Pointer to a rectangle that specifies the size of a quiet zone. \param[in] eQZUnit The units in which the size of a quiet zone is given (valid units are: eMUDefault, eMUPixel, eMUMM, eMUMils, eMUInch, eMUModules).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if an error occurred.
See also:
BCGetQuietZone() ----------------------------------------------------------------------------.


BOOL BCGetUseQuietZoneDefaultColor (t_BarCode* pBarCode, e_QuietZone eZone)
 Determines whether default background color shall be used for given quiet zone side. Returns currently adjusted value.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetBkMode(), BCGetBkMode(), BCSetColorBk(), BCGetColorBk(), BCSetQuietZoneColorCMYK(), BCSetQuietZoneColorGDI(), BCSetQuietZoneColorGray(), BCSetQuietZoneColorRGB() \param[in] pBarCode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side.
Return values:
BOOL   TRUE if default color shall be used, FALSE otherwise. ----------------------------------------------------------------------------.


VOID BCGetQuietZoneColorCMYK (const t_BarCode* pBarcode, e_QuietZone eZone, DOUBLE* pdCyan, DOUBLE* pdMagenta, DOUBLE* pdYellow, DOUBLE* pdBlack)
 Retrieves the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdCyan The cyan color component (range: 0.0 - 1.0). \param[out] pdMagenta The magenta color component (range: 0.0 - 1.0). \param[out] pdYellow The yellow color component (range: 0.0 - 1.0). \param[out] pdBlack The black component (range: 0.0 - 1.0). ----------------------------------------------------------------------------.


VOID BCSetQuietZoneColorCMYK (t_BarCode* pBarcode, e_QuietZone eZone, BOOL bUseDefault, DOUBLE dCyan, DOUBLE dMagenta, DOUBLE dYellow, DOUBLE dBlack)
 Sets the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dCyan The cyan color component (range: 0.0 - 1.0). \param[in] dMagenta The magenta color component (range: 0.0 - 1.0). \param[in] dYellow The yellow color component (range: 0.0 - 1.0). \param[in] dBlack The black color component (range: 0.0 - 1.0). ----------------------------------------------------------------------------.


VOID BCGetQuietZoneColorGDI (const t_BarCode* pBarcode, e_QuietZone eZone, COLORREF* pColor)
 Retrieves the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorGDI(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pColor The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.


VOID BCSetQuietZoneColorGDI (t_BarCode* pBarcode, e_QuietZone eZone, BOOL bUseDefault, COLORREF color)
 Sets the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] color The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.


VOID BCGetQuietZoneColorGray (const t_BarCode* pBarcode, e_QuietZone eZone, DOUBLE* pdGray)
 Retrieves the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorGray(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdGray The grayscale color of the barcode (range 0.0 - 1.0). ----------------------------------------------------------------------------.


VOID BCSetQuietZoneColorGray (t_BarCode* pBarcode, e_QuietZone eZone, BOOL bUseDefault, DOUBLE dGray)
 Sets the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dGray The grayscale color of the barcode (range: 0.0 - 1.0). ----------------------------------------------------------------------------.


VOID BCGetQuietZoneColorRGB (const t_BarCode* pBarcode, e_QuietZone eZone, DOUBLE* pdRed, DOUBLE* pdGreen, DOUBLE* pdBlue)
 Retrieves the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorRGB(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdRed The red color component (range: 0.0 - 1.0) \param[out] pdGreen The green color component (range: 0.0 - 1.0) \param[out] pdBlue The blue color component (range: 0.0 - 1.0) ----------------------------------------------------------------------------.


VOID BCSetQuietZoneColorRGB (t_BarCode* pBarcode, e_QuietZone eZone, BOOL bUseDefault, DOUBLE dRed, DOUBLE dGreen, DOUBLE dBlue)
 Sets the background color of the quiet zone.
Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dRed Red color component (range: 0.0 - 1.0) \param[in] dGreen Green color component (range: 0.0 - 1.0) \param[in] dBlue Blue color component (range: 0.0 - 1.0) ----------------------------------------------------------------------------.



Function Documentation

const LPRECTD BCGetQuietZone ( t_BarCode * pBarCode )

Gets current quiet-zone settings. Returns currently adjusted value.

See also:
BCSetQuietZone() \param[in] pBarCode Pointer to barcode structure.
Return values:
LPCRECT   rectangle specifying the quiet-zone dimensions [modules]. ----------------------------------------------------------------------------.

VOID BCGetQuietZoneColorCMYK ( const t_BarCode * pBarcode,
e_QuietZone eZone,
DOUBLE * pdCyan,
DOUBLE * pdMagenta,
DOUBLE * pdYellow,
DOUBLE * pdBlack )

Retrieves the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdCyan The cyan color component (range: 0.0 - 1.0). \param[out] pdMagenta The magenta color component (range: 0.0 - 1.0). \param[out] pdYellow The yellow color component (range: 0.0 - 1.0). \param[out] pdBlack The black component (range: 0.0 - 1.0). ----------------------------------------------------------------------------.

VOID BCGetQuietZoneColorGDI ( const t_BarCode * pBarcode,
e_QuietZone eZone,
COLORREF * pColor )

Retrieves the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorGDI(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pColor The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.

VOID BCGetQuietZoneColorGray ( const t_BarCode * pBarcode,
e_QuietZone eZone,
DOUBLE * pdGray )

Retrieves the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorGray(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdGray The grayscale color of the barcode (range 0.0 - 1.0). ----------------------------------------------------------------------------.

VOID BCGetQuietZoneColorRGB ( const t_BarCode * pBarcode,
e_QuietZone eZone,
DOUBLE * pdRed,
DOUBLE * pdGreen,
DOUBLE * pdBlue )

Retrieves the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetQuietZoneColorRGB(), BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCSetBkMode() \param[in] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[out] pdRed The red color component (range: 0.0 - 1.0) \param[out] pdGreen The green color component (range: 0.0 - 1.0) \param[out] pdBlue The blue color component (range: 0.0 - 1.0) ----------------------------------------------------------------------------.

e_MUnit BCGetQuietZoneUnit ( t_BarCode * pBarCode )

Gets current measurement unit used for specifying quiet-zones. Returns currently adjusted value.

See also:
BCSetQuietZone() \param[in] pBarCode Pointer to barcode structure.
Return values:
e_QZMUnit   Unit enumerator. ----------------------------------------------------------------------------.

BOOL BCGetUseQuietZoneDefaultColor ( t_BarCode * pBarCode,
e_QuietZone eZone )

Determines whether default background color shall be used for given quiet zone side. Returns currently adjusted value.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCSetBkMode(), BCGetBkMode(), BCSetColorBk(), BCGetColorBk(), BCSetQuietZoneColorCMYK(), BCSetQuietZoneColorGDI(), BCSetQuietZoneColorGray(), BCSetQuietZoneColorRGB() \param[in] pBarCode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side.
Return values:
BOOL   TRUE if default color shall be used, FALSE otherwise. ----------------------------------------------------------------------------.

ERRCODE BCSetQuietZone ( t_BarCode * pBarCode,
LPRECTD prQuietZone,
e_MUnit eQZUnit )

Sets the size of the quiet-zones in given units. Specifies the size of the required quiet zone in the respective units. A quiet zone is an unprinted area above, below, right, or left of a barcode.

Note:
If you specify the quiet zone in modules, the width of the quiet zone depends on the module width (respectively “narrow bar width X”). \param[in] pBarCode Pointer to barcode structure. \param[in] prQuietZone Pointer to a rectangle that specifies the size of a quiet zone. \param[in] eQZUnit The units in which the size of a quiet zone is given (valid units are: eMUDefault, eMUPixel, eMUMM, eMUMils, eMUInch, eMUModules).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if an error occurred.
See also:
BCGetQuietZone() ----------------------------------------------------------------------------.

VOID BCSetQuietZoneColorCMYK ( t_BarCode * pBarcode,
e_QuietZone eZone,
BOOL bUseDefault,
DOUBLE dCyan,
DOUBLE dMagenta,
DOUBLE dYellow,
DOUBLE dBlack )

Sets the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dCyan The cyan color component (range: 0.0 - 1.0). \param[in] dMagenta The magenta color component (range: 0.0 - 1.0). \param[in] dYellow The yellow color component (range: 0.0 - 1.0). \param[in] dBlack The black color component (range: 0.0 - 1.0). ----------------------------------------------------------------------------.

VOID BCSetQuietZoneColorGDI ( t_BarCode * pBarcode,
e_QuietZone eZone,
BOOL bUseDefault,
COLORREF color )

Sets the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] color The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.

VOID BCSetQuietZoneColorGray ( t_BarCode * pBarcode,
e_QuietZone eZone,
BOOL bUseDefault,
DOUBLE dGray )

Sets the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dGray The grayscale color of the barcode (range: 0.0 - 1.0). ----------------------------------------------------------------------------.

VOID BCSetQuietZoneColorRGB ( t_BarCode * pBarcode,
e_QuietZone eZone,
BOOL bUseDefault,
DOUBLE dRed,
DOUBLE dGreen,
DOUBLE dBlue )

Sets the background color of the quiet zone.

Note:
Property background mode must be opaque in order to draw the quiet zone with the specified background color.
See also:
BCGetQuietZoneColorCMYK(), BCGetQuietZoneColorGDI(), BCGetQuietZoneColorGray(), BCGetQuietZoneColorRGB(), BCSetBkMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] eZone Flag that determines the quiet zone side. \param[in] bUseDefault Flag that determines whether to use the default background color. If set to TRUE the given color values are ignored. \param[in] dRed Red color component (range: 0.0 - 1.0) \param[in] dGreen Green color component (range: 0.0 - 1.0) \param[in] dBlue Blue color component (range: 0.0 - 1.0) ----------------------------------------------------------------------------.


© 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