psapi.cpp File Reference

Public API functions to create barcodes in Postscript. More...


Functions

ERRCODE BCPostscriptToFileA (t_BarCode* pBarCode, LPCSTR szFilename, LPCRECT pRect)
 Saves barcode as a Postscript-file. Saves barcode (in EPS-format - Encapsulated Postscript) to a file.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.
See also:
BCPostscriptToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Filename. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero top / right specifies barcode dimensions
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPostscriptToFileW (t_BarCode* pBarCode, LPCWSTR szFilename, LPCRECT pRect)
 Saves barcode as a Postscript-file. Saves barcode (in EPS-format - Encapsulated Postscript) to a file.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.
See also:
BCPostscriptToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Filename. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero top / right specifies barcode dimensions
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPostscriptToMemory (t_BarCode* pBarCode, VOID* pHandle, INT nSize, LPCRECT pRect)
 Writes barcode (Postscript) into memory-block. Writes barcode into the specified memory block. The barcode is represented in vectorized PostScript (no bitmaps!).
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.
See also:
BCPostscriptToMemoryExt() \param[in] pBarCode Pointer to barcode structure. \param[in,out] pHandle Pointer to memory block. \param[in] nSize Size of memory block as allocated (including a terminating 0-byte). \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCPostscriptToMemoryExt (t_BarCode* pBarCode, VOID* pHandle, INT* pnSize, LPCRECT pRect, BOOL bIncludeMacros)
 Writes barcode (Postscript) into memory-block (extended version). Saves barcode in a memory block. The barcode is represented in vectorized PostScript (no bitmaps!). This function works like BCPostscriptToMemory() but allows additional specification of the required output resolution. Beside this it can be selected, if barcode-specific macros are to be included into the generated Postscript code.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.
See also:
BCPostscriptToMemory() \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 (including a terminating 0-byte). \param[in] pRect Bounding rectangle [1/1000 mm]. left / bottom must be zero, top / right specifies barcode dimensions [1/1000 mm]. \param[in] bIncludeMacros Exclude or include macro definitions. - true: Postscript Macros are included - false: Postscript Macros are excluded
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCGetPostscriptMacrosA (LPSTR pszMacros, INT* pnSize)
 Returns Postscript macros of the Postscript code as a zero-terminated string. This function is useful when embedding multiple barcodes in a single Postscript document using BCPostscriptToMemoryExt().
The Postscript codes returned by BCPostscriptToMemory() or BCPostscriptToMemoryExt() internally use a series of Postscript macros. These macros are defined at the begin of each barcode. When having several barcodes in a single Postscript document the macros need to be defined only once. To achieve this the Postscript code that defines the macros can be retrieved with this function. The barcodes can then be generated using BCPostscriptToMemoryExt() and setting bIncludeMacros to false. param[in,out] pszMacros Pointer to a memory block. param[in,out] pnSize Size of memory block as allocated. Contains required size after function call.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCGetPostscriptMacrosW (LPWSTR pszMacros, INT* pnSize)
 Returns Postscript macros of the Postscript code as a zero-terminated string. This function is useful when embedding multiple barcodes in a single Postscript document using BCPostscriptToMemoryExt().
The Postscript codes returned by BCPostscriptToMemory() or BCPostscriptToMemoryExt() internally use a series of Postscript macros. These macros are defined at the begin of each barcode. When having several barcodes in a single Postscript document the macros need to be defined only once. To achieve this the Postscript code that defines the macros can be retrieved with this function. The barcodes can then be generated using BCPostscriptToMemoryExt() and setting bIncludeMacros to false. param[in,out] pszMacros Pointer to a memory block. param[in,out] pnSize Size of memory block as allocated. Contains required size after function call.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


BOOL BCGetEpsSubstwDeviceFonts (t_BarCode* pBarCode)
 Gets current setting for substitute font names for EPS. Returns currently adjusted value.
See also:
BCSetEpsSubstwDeviceFonts() \param[in] pBarCode Pointer to barcode structure.
Return values:
false   No value set. This is the default
true   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSetEpsSubstwDeviceFonts (t_BarCode* pBarCode, BOOL bSubstitute)
 Activates the substitution of font names for EPS. Substitutes Windows font-names with Postscript-compatible fonts in functions BCSaveImage() and BCSaveImageExt() when using EPS Vector format.
See also:
BCGetEpsSubstwDeviceFonts(), BCSaveImage(),BCSaveImageExt() \param[in] pBarCode Pointer to barcode structure. \param[in] bSubstitute Substitute with Postscript fonts. - true: Substitute font-names enabled - false: Do not substitute font-names (this is the default)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.



Detailed Description

Public API functions to create barcodes in Postscript.

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

BOOL BCGetEpsSubstwDeviceFonts ( t_BarCode * pBarCode )

Gets current setting for substitute font names for EPS. Returns currently adjusted value.

See also:
BCSetEpsSubstwDeviceFonts() \param[in] pBarCode Pointer to barcode structure.
Return values:
false   No value set. This is the default
true   Otherwise ----------------------------------------------------------------------------.

ERRCODE BCGetPostscriptMacrosA ( LPSTR pszMacros,
INT * pnSize )

Returns Postscript macros of the Postscript code as a zero-terminated string. This function is useful when embedding multiple barcodes in a single Postscript document using BCPostscriptToMemoryExt().
The Postscript codes returned by BCPostscriptToMemory() or BCPostscriptToMemoryExt() internally use a series of Postscript macros. These macros are defined at the begin of each barcode. When having several barcodes in a single Postscript document the macros need to be defined only once. To achieve this the Postscript code that defines the macros can be retrieved with this function. The barcodes can then be generated using BCPostscriptToMemoryExt() and setting bIncludeMacros to false. param[in,out] pszMacros Pointer to a memory block. param[in,out] pnSize Size of memory block as allocated. Contains required size after function call.

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

ERRCODE BCGetPostscriptMacrosW ( LPWSTR pszMacros,
INT * pnSize )

Returns Postscript macros of the Postscript code as a zero-terminated string. This function is useful when embedding multiple barcodes in a single Postscript document using BCPostscriptToMemoryExt().
The Postscript codes returned by BCPostscriptToMemory() or BCPostscriptToMemoryExt() internally use a series of Postscript macros. These macros are defined at the begin of each barcode. When having several barcodes in a single Postscript document the macros need to be defined only once. To achieve this the Postscript code that defines the macros can be retrieved with this function. The barcodes can then be generated using BCPostscriptToMemoryExt() and setting bIncludeMacros to false. param[in,out] pszMacros Pointer to a memory block. param[in,out] pnSize Size of memory block as allocated. Contains required size after function call.

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

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

Saves barcode as a Postscript-file. Saves barcode (in EPS-format - Encapsulated Postscript) to a file.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.

See also:
BCPostscriptToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Filename. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero top / right specifies barcode dimensions
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

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

Saves barcode as a Postscript-file. Saves barcode (in EPS-format - Encapsulated Postscript) to a file.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.

See also:
BCPostscriptToMemory() \param[in] pBarCode Pointer to barcode structure. \param[in] szFilename Filename. \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero top / right specifies barcode dimensions
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

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

Writes barcode (Postscript) into memory-block. Writes barcode into the specified memory block. The barcode is represented in vectorized PostScript (no bitmaps!).
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.

See also:
BCPostscriptToMemoryExt() \param[in] pBarCode Pointer to barcode structure. \param[in,out] pHandle Pointer to memory block. \param[in] nSize Size of memory block as allocated (including a terminating 0-byte). \param[in] pRect Bounding rectangle for barcode dimensions [1/1000 mm]. left / bottom must be zero
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCPostscriptToMemoryExt ( t_BarCode * pBarCode,
VOID * pHandle,
INT * pnSize,
LPCRECT pRect,
BOOL bIncludeMacros )

Writes barcode (Postscript) into memory-block (extended version). Saves barcode in a memory block. The barcode is represented in vectorized PostScript (no bitmaps!). This function works like BCPostscriptToMemory() but allows additional specification of the required output resolution. Beside this it can be selected, if barcode-specific macros are to be included into the generated Postscript code.
The origin of the coordinate space in Postscript is the lower, left corner of a page. The positive y-axis points upwards.

See also:
BCPostscriptToMemory() \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 (including a terminating 0-byte). \param[in] pRect Bounding rectangle [1/1000 mm]. left / bottom must be zero, top / right specifies barcode dimensions [1/1000 mm]. \param[in] bIncludeMacros Exclude or include macro definitions. - true: Postscript Macros are included - false: Postscript Macros are excluded
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSetEpsSubstwDeviceFonts ( t_BarCode * pBarCode,
BOOL bSubstitute )

Activates the substitution of font names for EPS. Substitutes Windows font-names with Postscript-compatible fonts in functions BCSaveImage() and BCSaveImageExt() when using EPS Vector format.

See also:
BCGetEpsSubstwDeviceFonts(), BCSaveImage(),BCSaveImageExt() \param[in] pBarCode Pointer to barcode structure. \param[in] bSubstitute Substitute with Postscript fonts. - true: Substitute font-names enabled - false: Do not substitute font-names (this is the default)
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