Functions |
| DOUBLE | Clamp01 (DOUBLE value) |
| | \cond DEVELOPER_DOC Clamps a value to the range 0.0 - 1.0. \param[in] value The value which shall be clamped -
Returns:
-
A value in the range 0.0 - 1.0.
|
| COLORREF | BCGetColorBC (t_BarCode* pBarCode) |
| | Gets the current barcode color. Returns currently adjusted value. -
Deprecated:
-
Handling of color values has been enhanced. Use BCGetBarcodeColorGDI(), BCGetBarcodeColorRGB(), BCGetBarcodeColorCMYK(), or BCGetBarcodeColorGray() instead.
-
See also:
-
BCSetColorBC() \param[in] pBarCode Pointer to barcode structure
-
Return values:
-
| COLORREF
|
Current value. Black is the default ----------------------------------------------------------------------------. |
|
| ERRCODE | BCSetColorBC (t_BarCode* pBarCode, COLORREF color) |
| | Sets the color the of barcode. Specifies the color of the bars (or dots) of the barcode. -
See also:
-
BCGetColorBC()
-
Deprecated:
-
Handling of color values has been enhanced. Use BCSetBarcodeColorGDI(), BCSetBarcodeColorRGB(), BCSetBarcodeColorCMYK(), or BCSetBarcodeColorGray() instead. \param[in] pBarCode Pointer to barcode structure \param[in] color RGB color value
-
Return values:
-
| ERRCODE
|
ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------. |
|
| COLORREF | BCGetColorBk (t_BarCode* pBarCode) |
| | Gets the current background color. Returns currently adjusted value. -
See also:
-
BCSetColorBk()
-
Deprecated:
-
Handling of color values has been enhanced. Use BCGetBackgroundColorGDI(), BCGetBackgroundColorRGB(), BCGetBackgroundColorCMYK(), or BCGetBackgroundColorGray() instead. \param[in] pBarCode Pointer to barcode structure.
-
Return values:
-
| COLORREF
|
Current value. White is the default ----------------------------------------------------------------------------. |
|
| ERRCODE | BCSetColorBk (t_BarCode* pBarCode, COLORREF color) |
| | Sets the color of the barcode background. Specifies the background color of the barcode. This color is used to draw the spaces of the barcode when the BackStyle is set to OPAQUE. -
See also:
-
BCGetColorBk(), BCSetBkMode()
-
Deprecated:
-
Handling of color values has been enhanced. Use BCSetBackgroundColorGDI(), BCSetBackgroundColorRGB(), BCSetBackgroundColorCMYK(), or BCSetBackgroundColorGray() instead. \param[in] pBarCode Pointer to barcode structure. \param[in] color RGB color value.
-
Return values:
-
| ERRCODE
|
ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------. |
|
| COLORREF | BCGetColorFont (t_BarCode* pBarCode) |
| | Gets the current color of the human readable text. Returns currently adjusted value. -
See also:
-
BCSetColorFont()
-
Deprecated:
-
Handling of color values has been enhanced. Use BCGetFontColorGDI(), BCGetFontColorRGB(), BCGetFontColorCMYK(), or BCGetFontColorGray() instead. \param[in] pBarCode Pointer to barcode structure.
-
Return values:
-
| COLORREF
|
Current value. Black is the default ----------------------------------------------------------------------------. |
|
| ERRCODE | BCSetColorFont (t_BarCode* pBarCode, COLORREF color) |
| | Sets the color of the human readable text. Used only when drawing of the human-readable text is activated (see BCSetPrintText()) -
See also:
-
BCGetColorFont(), BCSetPrintText()
-
Deprecated:
-
Handling of color values has been enhanced. Use BCSetFontColorGDI(), BCSetFontColorRGB(), BCSetFontColorCMYK(), or BCSetFontColorGray() instead. \param[in] pBarCode Pointer to barcode structure. \param[in] color RGB color value.
-
Return values:
-
| ERRCODE
|
ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------. |
|
| e_ColorMode | BCGetColorMode (const t_BarCode* pBarcode) |
| | Retrieves the color mode (CMYK, RGB, or Grayscale). \param[in] pBarcode Pointer to barcode structure -
Returns:
-
The color mode ----------------------------------------------------------------------------.
|
| VOID | BCSetColorMode (t_BarCode* pBarcode, e_ColorMode mode) |
| | Sets the color mode (CMYK, RGB, or Grayscale). \param[in,out] pBarcode Pointer to barcode structure. \param[in] mode The color mode. ----------------------------------------------------------------------------.
|
| VOID | BCSetBarcodeColorCMYK (t_BarCode* pBarcode, DOUBLE dCyan, DOUBLE dMagenta, DOUBLE dYellow, DOUBLE dBlack) |
| | Sets the color of the barcode. -
See also:
-
BCGetBarcodeColorCMYK(), BCSetBarcodeColorGDI(), BCSetBarcodeColorGray(), BCSetBarcodeColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \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 | BCGetBarcodeColorCMYK (const t_BarCode* pBarcode, DOUBLE* pdCyan, DOUBLE* pdMagenta, DOUBLE* pdYellow, DOUBLE* pdBlack) |
| | Retrieves the color of the barcode. -
See also:
-
BCSetBarcodeColorCMYK(), BCGetBarcodeColorGDI(), BCGetBarcodeColorGray(), BCGetBarcodeColorRGB() \param[in] pBarcode Pointer to barcode structure. \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 | BCSetBarcodeColorGDI (t_BarCode* pBarcode, COLORREF color) |
| | Sets the color of the barcode. -
See also:
-
BCGetBarcodeColorGDI(), BCSetBarcodeColorCMYK(), BCSetBarcodeColorGray(), BCSetBarcodeColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \param[in] color The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCGetBarcodeColorGDI (const t_BarCode* pBarcode, COLORREF* pColor) |
| | Retrieves the color of the barcode. -
See also:
-
BCSetBarcodeColorGDI(), BCGetBarcodeColorCMYK(), BCGetBarcodeColorGray(), BCGetBarcodeColorRGB() \param[in] pBarcode Pointer to barcode structure. \param[out] pColor The RGB color of the barcode stored as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCSetBarcodeColorGray (t_BarCode* pBarcode, DOUBLE dGray) |
| | Sets the color of the barcode. -
See also:
-
BCGetBarcodeColorGray(), BCSetBarcodeColorCMYK(), BCSetBarcodeColorGDI(), BCSetBarcodeColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \param[in] dGray The grayscale color of the barcode (range: 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCGetBarcodeColorGray (const t_BarCode* pBarcode, DOUBLE* pdGray) |
| | Retrieves the color of the barcode. -
See also:
-
BCSetBarcodeColorGray(), BCGetBarcodeColorCMYK(), BCGetBarcodeColorGDI(), BCGetBarcodeColorRGB() \param[in] pBarcode Pointer to barcode structure. \param[out] pdGray The grayscale color of the barcode (range 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCSetBarcodeColorRGB (t_BarCode* pBarcode, DOUBLE dRed, DOUBLE dGreen, DOUBLE dBlue) |
| | Sets the color of the barcode. -
See also:
-
BCGetBarcodeColorRGB(), BCSetBarcodeColorCMYK(), BCSetBarcodeColorGDI(), BCSetBarcodeColorGray() \param[in,out] pBarcode Pointer to barcode structure. \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). ----------------------------------------------------------------------------.
|
| VOID | BCGetBarcodeColorRGB (const t_BarCode* pBarcode, DOUBLE* pdRed, DOUBLE* pdGreen, DOUBLE* pdBlue) |
| | Retrieves the RGB color of the barcode. -
See also:
-
BCSetBarcodeColorRGB(), BCGetBarcodeColorCMYK(), BCGetBarcodeColorGDI(), BCGetBarcodeColorGray() \param[in] pBarcode Pointer to barcode structure. \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 | BCGetFontColorCMYK (const t_BarCode* pBarcode, DOUBLE* pdCyan, DOUBLE* pdMagenta, DOUBLE* pdYellow, DOUBLE* pdBlack) |
| | Retrieves the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCSetFontColorCMYK(), BCGetFontColorGDI(), BCGetFontColorGray(), BCGetFontColorRGB(), BCSetActiveTextIndex() \param[in] pBarcode Pointer to barcode structure. \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 | BCSetFontColorCMYK (t_BarCode* pBarcode, DOUBLE dCyan, DOUBLE dMagenta, DOUBLE dYellow, DOUBLE dBlack) |
| | Sets the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCGetFontColorCMYK(), BCSetFontColorGDI(), BCSetFontColorGray(), BCSetFontColorRGB(), BCSetActiveTextIndex() \param[in,out] pBarcode Pointer to barcode structure. \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 | BCGetFontColorGDI (const t_BarCode* pBarcode, COLORREF* pColor) |
| | Sets the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCGetFontColorGDI(), BCSetFontColorCMYK(), BCSetFontColorGray(), BCSetFontColorRGB(), BCSetActiveTextIndex() \param[in,out] pBarcode Pointer to barcode structure. \param[out] pColor The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCSetFontColorGDI (t_BarCode* pBarcode, COLORREF color) |
| | Sets the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCGetFontColorGDI(), BCSetFontColorCMYK(), BCSetFontColorGray(), BCSetFontColorRGB(), BCSetActiveTextIndex() \param[in,out] pBarcode Pointer to barcode structure. \param[in] color The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCGetFontColorGray (const t_BarCode* pBarcode, DOUBLE* pdGray) |
| | Retrieves the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCSetFontColorGray(), BCGetFontColorCMYK(), BCGetFontColorGDI(), BCGetFontColorRGB(), BCSetActiveTextIndex() \param[in] pBarcode Pointer to barcode structure. \param[out] pdGray The grayscale color of the barcode (range 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCSetFontColorGray (t_BarCode* pBarcode, DOUBLE dGray) |
| | Sets the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCGetFontColorGray(), BCSetFontColorCMYK(), BCSetFontColorGDI(), BCSetFontColorRGB(), BCSetActiveTextIndex() \param[in,out] pBarcode Pointer to barcode structure. \param[in] dGray The grayscale color of the barcode (range: 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCGetFontColorRGB (const t_BarCode* pBarcode, DOUBLE* pdRed, DOUBLE* pdGreen, DOUBLE* pdBlue) |
| | Retrieves the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCSetFontColorRGB(), BCGetFontColorCMYK(), BCGetFontColorGDI(), BCGetFontColorGray(), BCSetActiveTextIndex() \param[in] pBarcode Pointer to barcode structure. \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 | BCSetFontColorRGB (t_BarCode* pBarcode, DOUBLE dRed, DOUBLE dGreen, DOUBLE dBlue) |
| | Sets the font color of the currently active text object (usually the human readable text). -
Note:
-
The currently active text object can be selected by calling BCSetActiveTextIndex()
-
See also:
-
BCGetFontColorRGB(), BCSetFontColorCMYK(), BCSetFontColorGDI(), BCSetFontColorGray(), BCSetActiveTextIndex() \param[in,out] pBarcode Pointer to barcode structure. \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) ----------------------------------------------------------------------------.
|
| VOID | BCSetBackgroundColorCMYK (t_BarCode* pBarcode, DOUBLE dCyan, DOUBLE dMagenta, DOUBLE dYellow, DOUBLE dBlack) |
| | Sets the background color the of barcode. -
See also:
-
BCGetBackgroundColorCMYK(), BCSetBackgroundColorGDI(), BCSetBackgroundColorGray(), BCSetBackgroundColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \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 | BCGetBackgroundColorCMYK (const t_BarCode* pBarcode, DOUBLE* pdCyan, DOUBLE* pdMagenta, DOUBLE* pdYellow, DOUBLE* pdBlack) |
| | Retrieves the background color of the barcode. -
See also:
-
BCSetBackgroundColorCMYK(), BCGetBackgroundColorGDI(), BCGetBackgroundColorGray(), BCGetBackgroundColorRGB() \param[in] pBarcode Pointer to barcode structure. \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 | BCSetBackgroundColorGDI (t_BarCode* pBarcode, COLORREF color) |
| | Sets the background color of the barcode. -
See also:
-
BCGetBackgroundColorGDI(), BCSetBackgroundColorCMYK(), BCSetBackgroundColorGray(), BCSetBackgroundColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \param[in] color The RGB color of the barcode encoded as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCGetBackgroundColorGDI (const t_BarCode* pBarcode, COLORREF* pColor) |
| | Retrieves the background color of the barcode. -
See also:
-
BCSetBackgroundColorGDI(), BCGetBackgroundColorCMYK(), BCGetBackgroundColorGray(), BCGetBackgroundColorRGB() \param[in] pBarcode Pointer to barcode structure. \param[out] pColor The RGB color of the barcode stored as COLORREF (DWORD). ----------------------------------------------------------------------------.
|
| VOID | BCSetBackgroundColorGray (t_BarCode* pBarcode, DOUBLE dGray) |
| | Sets the background color of the barcode. -
See also:
-
BCGetBackgroundColorGray(), BCSetBackgroundColorCMYK(), BCSetBackgroundColorGDI(), BCSetBackgroundColorRGB() \param[in,out] pBarcode Pointer to barcode structure. \param[in] dGray The grayscale color of the barcode (range: 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCGetBackgroundColorGray (const t_BarCode* pBarcode, DOUBLE* pdGray) |
| | Retrieves the background color of the barcode. -
See also:
-
BCSetBackgroundColorGray(), BCGetBackgroundColorCMYK(), BCGetBackgroundColorGDI(), BCGetBackgroundColorRGB() \param[in] pBarcode Pointer to barcode structure. \param[out] pdGray The grayscale color of the barcode (range 0.0 - 1.0). ----------------------------------------------------------------------------.
|
| VOID | BCSetBackgroundColorRGB (t_BarCode* pBarcode, DOUBLE dRed, DOUBLE dGreen, DOUBLE dBlue) |
| | Sets the background color of the barcode. -
See also:
-
BCGetBackgroundColorRGB(), BCSetBackgroundColorCMYK(), BCSetBackgroundColorGDI(), BCSetBackgroundColorGray() \param[in,out] pBarcode Pointer to barcode structure. \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) ----------------------------------------------------------------------------.
|
| VOID | BCGetBackgroundColorRGB (const t_BarCode* pBarcode, DOUBLE* pdRed, DOUBLE* pdGreen, DOUBLE* pdBlue) |
| | Retrieves the background color of the barcode. -
See also:
-
BCSetBackgroundColorRGB(), BCGetBackgroundColorCMYK(), BCGetBackgroundColorGDI(), BCGetBackgroundColorGray() \param[in] pBarcode Pointer to barcode structure. \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) ----------------------------------------------------------------------------.
|
