pclapi.cpp File Reference

Public API functions to create barcodes as PCL. More...


Functions

ERRCODE BCPCLToFileA (t_BarCode* pBarCode, LPCSTR szFilename, LPCRECT pRect)
 Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.
See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPCLToFileW (t_BarCode* pBarCode, LPCWSTR szFilename, LPCRECT pRect)
 Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.
See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPCLToFileExtA (t_BarCode* pBarCode, LPCSTR szFilename, LPCRECT pRect, BOOL bRelPos)
 Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.
See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPCLToFileExtW (t_BarCode* pBarCode, LPCWSTR szFilename, LPCRECT pRect, BOOL bRelPos)
 Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.
See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPCLToMemory (t_BarCode* pBarCode, VOID* pHandle, INT nSize, LPCRECT pRect)
 Writes barcode as PCL (Level 5) into memory block. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.
See also:
BCPCLToMemoryExt() \param[in] pBarCode Pointer to barcode structure. \param[in] pHandle Pointer to memory block. \param[in] nSize Size of memory block as allocated. \param[in] pRect Bounding rectangle [1/1000 mm].
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPCLToMemoryExt (t_BarCode* pBarCode, VOID* pHandle, INT* pnSize, LPCRECT pRect, BOOL bRelPos)
 Writes barcode as PCL Level 5 into memory block (extended version). In addition to BCPCLToMemory() the required output resolution can be specified. Beside this, the parameter bRelPos switches between absolute or relative positioning.
The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards. \param[in] pBarCode Pointer to barcode structure. \param[in] pHandle Pointer to memory block. \param[in,out] pnSize Size of memory block as allocated. Contains required size after function call. \param[in] pRect Bounding rectangle [1/1000 mm]. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCPCLToMemory() ----------------------------------------------------------------------------.


e_PCLMode BCGetPCLMode (const t_BarCode* pBarcode)
 Retrieves the PCL output mode.
See also:
BCSetPCLMode() \param[in] pBarcode Pointer to barcode structure
Returns:
The PCL output mode. ----------------------------------------------------------------------------.


VOID BCSetPCLMode (t_BarCode* pBarcode, e_PCLMode mode)
 Sets the PCL output mode. By default functions, such as BCPCLToFile(), create PCL Level 5 output which includes HP-GL/2 drawing operations. HP-GL/2 is part of PCL Level 5 and thus should be supported by all PCL Level 5 compatible printers. Though, some printers and some conversion tools cannot handle HP-GL/2 instructions correctly.
With this function the HP-GL/2 output generation can be turned off.
But you need to be aware that some barcode types, such as MAXICODE, can only be drawn when with HP-GL/2 enabled.
See also:
BCGetPCLMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] mode The PCL output mode. ----------------------------------------------------------------------------.



Detailed Description

Public API functions to create barcodes as PCL.

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_PCLMode BCGetPCLMode ( const t_BarCode * pBarcode )

Retrieves the PCL output mode.

See also:
BCSetPCLMode() \param[in] pBarcode Pointer to barcode structure
Returns:
The PCL output mode. ----------------------------------------------------------------------------.

ERRCODE BCPCLToFileA ( t_BarCode * pBarCode,
LPCSTR szFilename,
LPCRECT pRect )

Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.

See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPCLToFileExtA ( t_BarCode * pBarCode,
LPCSTR szFilename,
LPCRECT pRect,
BOOL bRelPos )

Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.

See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPCLToFileExtW ( t_BarCode * pBarCode,
LPCWSTR szFilename,
LPCRECT pRect,
BOOL bRelPos )

Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.

See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPCLToFileW ( t_BarCode * pBarCode,
LPCWSTR szFilename,
LPCRECT pRect )

Saves barcode as a PCL-file. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.

See also:
BCPCLToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Path and name of file. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. (left, bottom) is the lower left corner of the barcode (usually (0, 0)). (right, top) is the upper right corner of the barcode.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPCLToMemory ( t_BarCode * pBarCode,
VOID * pHandle,
INT nSize,
LPCRECT pRect )

Writes barcode as PCL (Level 5) into memory block. The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards.

See also:
BCPCLToMemoryExt() \param[in] pBarCode Pointer to barcode structure. \param[in] pHandle Pointer to memory block. \param[in] nSize Size of memory block as allocated. \param[in] pRect Bounding rectangle [1/1000 mm].
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPCLToMemoryExt ( t_BarCode * pBarCode,
VOID * pHandle,
INT * pnSize,
LPCRECT pRect,
BOOL bRelPos )

Writes barcode as PCL Level 5 into memory block (extended version). In addition to BCPCLToMemory() the required output resolution can be specified. Beside this, the parameter bRelPos switches between absolute or relative positioning.
The origin of the coordinate space in PCL the is upper, left corner of a page. The positive y-axis points downwards. \param[in] pBarCode Pointer to barcode structure. \param[in] pHandle Pointer to memory block. \param[in,out] pnSize Size of memory block as allocated. Contains required size after function call. \param[in] pRect Bounding rectangle [1/1000 mm]. \param[in] bRelPos Relative or absolute positioning. - true: Relative positioning is used - false: Absolute positioning is used

Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred.
See also:
BCPCLToMemory() ----------------------------------------------------------------------------.

VOID BCSetPCLMode ( t_BarCode * pBarcode,
e_PCLMode mode )

Sets the PCL output mode. By default functions, such as BCPCLToFile(), create PCL Level 5 output which includes HP-GL/2 drawing operations. HP-GL/2 is part of PCL Level 5 and thus should be supported by all PCL Level 5 compatible printers. Though, some printers and some conversion tools cannot handle HP-GL/2 instructions correctly.
With this function the HP-GL/2 output generation can be turned off.
But you need to be aware that some barcode types, such as MAXICODE, can only be drawn when with HP-GL/2 enabled.

See also:
BCGetPCLMode() \param[in,out] pBarcode Pointer to barcode structure. \param[in] mode The PCL output mode. ----------------------------------------------------------------------------.


© 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