macpdfapi.cpp File Reference

Public API functions for Macro-PDF417. More...


Functions

LONG BCGet_PDF417_SegIndex (t_BarCode* pBarCode)
 Gets current Macro-PDF417 segment index. Returns currently adjusted value.
See also:
BCSet_PDF417_SegIndex() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
1...99999   ] Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_PDF417_FileIDA (t_BarCode* pBarCode)
 Gets Macro PDF417 FileID. Returns currently adjusted value.
See also:
BCSet_PDF417_FileID() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_PDF417_FileIDW (t_BarCode* pBarCode)
 Gets Macro PDF417 FileID. Returns currently adjusted value.
See also:
BCSet_PDF417_FileID() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


BOOL BCGet_PDF417_SegLast (t_BarCode* pBarCode)
 Returns if this is the last symbol within a Macro PDF417 symbol-chain. Returns currently adjusted value.
See also:
BCSet_PDF417_SegLast() \param[in] pBarCode Pointer to barcode structure.
Return values:
true   Current symbol is the last symbol within this chain
false   Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_PDF417_FileNameA (t_BarCode* pBarCode)
 Gets Macro PDF417 File Name. Returns currently adjusted value.
See also:
BCSet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_PDF417_FileNameW (t_BarCode* pBarCode)
 Gets Macro PDF417 File Name. Returns currently adjusted value.
See also:
BCSet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LONG BCGet_PDF417_SegCount (t_BarCode* pBarCode)
 Gets Macro PDF417 segment count. Returns currently adjusted value.
See also:
BCGet_PDF417_SegCount() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
1...99999   ] Otherwise ----------------------------------------------------------------------------.


LONG BCGet_PDF417_TimeStamp (t_BarCode* pBarCode)
 Gets Macro PDF417 Time Stamp. Returns currently adjusted value.
See also:
BCSet_PDF417_TimeStamp() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_PDF417_SenderA (t_BarCode* pBarCode)
 Gets Macro PDF417 Sender. Returns currently adjusted value.
See also:
BCSet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_PDF417_SenderW (t_BarCode* pBarCode)
 Gets Macro PDF417 Sender. Returns currently adjusted value.
See also:
BCSet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_PDF417_AddresseeA (t_BarCode* pBarCode)
 Gets Macro PDF417 Addressee. Returns currently adjusted value
See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_PDF417_AddresseeW (t_BarCode* pBarCode)
 Gets Macro PDF417 Addressee. Returns currently adjusted value
See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure.
Return values:
NULL   No value set. This is the default
String   Otherwise ----------------------------------------------------------------------------.


LONG BCGet_PDF417_FileSize (t_BarCode* pBarCode)
 Gets Macro PDF417 File Size. Returns currently adjusted value
See also:
BCSet_PDF417_FileSize() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.


LONG BCGet_PDF417_CheckSum (t_BarCode* pBarCode)
 \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_SegIndex (t_BarCode* pBarCode, LONG nSegInx)
 Sets Macro-PDF417 segment index. Index of the actual data segment in the symbol chain. Begin with 1 and increase for each additional symbol in the data chain.
Macro PDF will be enabled only if the Segment index and the File ID are set. Default: Macro PDF is disabled.
PDF417 allows user data to be spread across several symbols. This might be done if the data is too large to fit into a single symbol or for reasons of appearance and geometry.
The so called "Macro PDF Control Block" carries additional control information that enables the reading device to reconstruct the data of all symbols in the correct order Macro PDF functionality is also available for MicroPDF417.
Note:
When reading the encoded data with a bar code scanner, the index may be zero-based.
See also:
BCGet_PDF417_SegIndex() BCSet_PDF417_FileID() \param[in] pBarCode Pointer to barcode structure. \param[in] nSegInx Segment index [1...99999] (reset to default/disable = -1).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_FileIDA (t_BarCode* pBarCode, LPCSTR szFileID)
 Sets Macro PDF417 FileID. The File-ID identifies all symbols, which belong to the same data chain. For reassembling, all data blocks having the same File-ID are concatenated in the order of increasing segment index.
Macro PDF will be enabled only if the Segment-index and the File-ID are set. Default: MacroPDF is disabled.
See also:
BCGet_PDF417_FileID() BCSet_PDF417_SegIndex() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileID File ID string (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_FileIDW (t_BarCode* pBarCode, LPCWSTR szFileID)
 Sets Macro PDF417 FileID. The File-ID identifies all symbols, which belong to the same data chain. For reassembling, all data blocks having the same File-ID are concatenated in the order of increasing segment index.
Macro PDF will be enabled only if the Segment-index and the File-ID are set. Default: MacroPDF is disabled.
See also:
BCGet_PDF417_FileID() BCSet_PDF417_SegIndex() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileID File ID string (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_SegLast (t_BarCode* pBarCode, BOOL bSegLast)
 Marks the actual symbol as the last one within the Macro PDF417 symbol chain. Marks the current symbol as the last one within the actual symbol chain. This feature is used when generating Macro PDF417. Some applications require the segment count to be set for identifying the last bar code in the symbol chain.
See also:
BCGet_PDF417_SegLast() BCSet_PDF417_SegCount() \param[in] pBarCode Pointer to barcode structure. \param[in] bSegLast Is last segment.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_FileNameA (t_BarCode* pBarCode, LPCSTR szFileName)
 Sets Macro PDF417 File Name (optional). Specifies file name (alphanumeric, variable length)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileName File name (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_FileNameW (t_BarCode* pBarCode, LPCWSTR szFileName)
 Sets Macro PDF417 File Name (optional). Specifies file name (alphanumeric, variable length)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileName File name (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_SegCount (t_BarCode* pBarCode, LONG nSegCount)
 Sets Macro PDF417 segment count (optional). Specifies total number of bar codes in the symbol chain (numeric).
Optional field to be encoded into the Macro PDF control header block. Some applications require this field to be set (instead or in combination with the last segment marker).
See also:
BCGet_PDF417_SegCount() \param[in] pBarCode Pointer to barcode structure. \param[in] nSegCount Segment count [1...99999] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_TimeStamp (t_BarCode* pBarCode, LONG nTimeStamp)
 Sets Macro PDF417 Time Stamp (optional). Specifies time stamp (elapsed time in seconds since January 1, 1970 00:00 GMT) (numeric)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCSet_PDF417_TimeStamp() \param[in] pBarCode Pointer to barcode structure. \param[in] nTimeStamp Time stamp (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_SenderA (t_BarCode* pBarCode, LPCSTR szSender)
 Sets Macro PDF417 Sender (optional). Specifies sender (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure. \param[in] szSender Sender (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_SenderW (t_BarCode* pBarCode, LPCWSTR szSender)
 Sets Macro PDF417 Sender (optional). Specifies sender (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure. \param[in] szSender Sender (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_AddresseeA (t_BarCode* pBarCode, LPCSTR szAddressee)
 Sets Macro PDF417 Addressee (optional). Specifies addressee (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure. \param[in] szAddressee ///< IN : Addressee (reset to default = null)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_AddresseeW (t_BarCode* pBarCode, LPCWSTR szAddressee)
 Sets Macro PDF417 Addressee (optional). Specifies addressee (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure. \param[in] szAddressee ///< IN : Addressee (reset to default = null)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_FileSize (t_BarCode* pBarCode, LONG nFileSize)
 Sets Macro PDF417 File Size (optional). Specifies total number of Bytes encoded (numeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_FileSize() \param[in] pBarCode Pointer to barcode structure. \param[in] nFileSize File Size (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


ERRCODE BCSet_PDF417_CheckSum (t_BarCode* pBarCode, LONG nCheckSum)
 Sets Macro PDF417 Check Sum (optional). Sets 16-Bit CRC checksum (using CCITT-16 polynomial x16 + x12 + x5 + 1 over the entire data)
Optional field to be encoded into the Macro PDF control header block. Default: unused.
See also:
BCGet_PDF417_CheckSum() \param[in] pBarCode Pointer to barcode structure. \param[in] nCheckSum Check sum (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.


Detailed Description

Public API functions for Macro-PDF417.

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

LPCSTR BCGet_PDF417_AddresseeA ( t_BarCode * pBarCode )

Gets Macro PDF417 Addressee. Returns currently adjusted value

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

LPCWSTR BCGet_PDF417_AddresseeW ( t_BarCode * pBarCode )

Gets Macro PDF417 Addressee. Returns currently adjusted value

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

LONG BCGet_PDF417_CheckSum ( t_BarCode * pBarCode )

\param[in] pBarCode Pointer to barcode structure.

Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.

LPCSTR BCGet_PDF417_FileIDA ( t_BarCode * pBarCode )

Gets Macro PDF417 FileID. Returns currently adjusted value.

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

LPCWSTR BCGet_PDF417_FileIDW ( t_BarCode * pBarCode )

Gets Macro PDF417 FileID. Returns currently adjusted value.

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

LPCSTR BCGet_PDF417_FileNameA ( t_BarCode * pBarCode )

Gets Macro PDF417 File Name. Returns currently adjusted value.

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

LPCWSTR BCGet_PDF417_FileNameW ( t_BarCode * pBarCode )

Gets Macro PDF417 File Name. Returns currently adjusted value.

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

LONG BCGet_PDF417_FileSize ( t_BarCode * pBarCode )

Gets Macro PDF417 File Size. Returns currently adjusted value

See also:
BCSet_PDF417_FileSize() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.

LONG BCGet_PDF417_SegCount ( t_BarCode * pBarCode )

Gets Macro PDF417 segment count. Returns currently adjusted value.

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

LONG BCGet_PDF417_SegIndex ( t_BarCode * pBarCode )

Gets current Macro-PDF417 segment index. Returns currently adjusted value.

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

BOOL BCGet_PDF417_SegLast ( t_BarCode * pBarCode )

Returns if this is the last symbol within a Macro PDF417 symbol-chain. Returns currently adjusted value.

See also:
BCSet_PDF417_SegLast() \param[in] pBarCode Pointer to barcode structure.
Return values:
true   Current symbol is the last symbol within this chain
false   Otherwise ----------------------------------------------------------------------------.

LPCSTR BCGet_PDF417_SenderA ( t_BarCode * pBarCode )

Gets Macro PDF417 Sender. Returns currently adjusted value.

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

LPCWSTR BCGet_PDF417_SenderW ( t_BarCode * pBarCode )

Gets Macro PDF417 Sender. Returns currently adjusted value.

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

LONG BCGet_PDF417_TimeStamp ( t_BarCode * pBarCode )

Gets Macro PDF417 Time Stamp. Returns currently adjusted value.

See also:
BCSet_PDF417_TimeStamp() \param[in] pBarCode Pointer to barcode structure.
Return values:
-1   No value set. This is the default
>0   Otherwise ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_AddresseeA ( t_BarCode * pBarCode,
LPCSTR szAddressee )

Sets Macro PDF417 Addressee (optional). Specifies addressee (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure. \param[in] szAddressee ///< IN : Addressee (reset to default = null)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_AddresseeW ( t_BarCode * pBarCode,
LPCWSTR szAddressee )

Sets Macro PDF417 Addressee (optional). Specifies addressee (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCSet_PDF417_Adressee() \param[in] pBarCode Pointer to barcode structure. \param[in] szAddressee ///< IN : Addressee (reset to default = null)
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_CheckSum ( t_BarCode * pBarCode,
LONG nCheckSum )

Sets Macro PDF417 Check Sum (optional). Sets 16-Bit CRC checksum (using CCITT-16 polynomial x16 + x12 + x5 + 1 over the entire data)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_CheckSum() \param[in] pBarCode Pointer to barcode structure. \param[in] nCheckSum Check sum (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_FileIDA ( t_BarCode * pBarCode,
LPCSTR szFileID )

Sets Macro PDF417 FileID. The File-ID identifies all symbols, which belong to the same data chain. For reassembling, all data blocks having the same File-ID are concatenated in the order of increasing segment index.
Macro PDF will be enabled only if the Segment-index and the File-ID are set. Default: MacroPDF is disabled.

See also:
BCGet_PDF417_FileID() BCSet_PDF417_SegIndex() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileID File ID string (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_FileIDW ( t_BarCode * pBarCode,
LPCWSTR szFileID )

Sets Macro PDF417 FileID. The File-ID identifies all symbols, which belong to the same data chain. For reassembling, all data blocks having the same File-ID are concatenated in the order of increasing segment index.
Macro PDF will be enabled only if the Segment-index and the File-ID are set. Default: MacroPDF is disabled.

See also:
BCGet_PDF417_FileID() BCSet_PDF417_SegIndex() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileID File ID string (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_FileNameA ( t_BarCode * pBarCode,
LPCSTR szFileName )

Sets Macro PDF417 File Name (optional). Specifies file name (alphanumeric, variable length)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileName File name (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_FileNameW ( t_BarCode * pBarCode,
LPCWSTR szFileName )

Sets Macro PDF417 File Name (optional). Specifies file name (alphanumeric, variable length)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_FileName() \param[in] pBarCode Pointer to barcode structure. \param[in] szFileName File name (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_FileSize ( t_BarCode * pBarCode,
LONG nFileSize )

Sets Macro PDF417 File Size (optional). Specifies total number of Bytes encoded (numeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_FileSize() \param[in] pBarCode Pointer to barcode structure. \param[in] nFileSize File Size (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_SegCount ( t_BarCode * pBarCode,
LONG nSegCount )

Sets Macro PDF417 segment count (optional). Specifies total number of bar codes in the symbol chain (numeric).
Optional field to be encoded into the Macro PDF control header block. Some applications require this field to be set (instead or in combination with the last segment marker).

See also:
BCGet_PDF417_SegCount() \param[in] pBarCode Pointer to barcode structure. \param[in] nSegCount Segment count [1...99999] (-1 ... reset to default).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_SegIndex ( t_BarCode * pBarCode,
LONG nSegInx )

Sets Macro-PDF417 segment index. Index of the actual data segment in the symbol chain. Begin with 1 and increase for each additional symbol in the data chain.
Macro PDF will be enabled only if the Segment index and the File ID are set. Default: Macro PDF is disabled.
PDF417 allows user data to be spread across several symbols. This might be done if the data is too large to fit into a single symbol or for reasons of appearance and geometry.
The so called "Macro PDF Control Block" carries additional control information that enables the reading device to reconstruct the data of all symbols in the correct order Macro PDF functionality is also available for MicroPDF417.

Note:
When reading the encoded data with a bar code scanner, the index may be zero-based.
See also:
BCGet_PDF417_SegIndex() BCSet_PDF417_FileID() \param[in] pBarCode Pointer to barcode structure. \param[in] nSegInx Segment index [1...99999] (reset to default/disable = -1).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_SegLast ( t_BarCode * pBarCode,
BOOL bSegLast )

Marks the actual symbol as the last one within the Macro PDF417 symbol chain. Marks the current symbol as the last one within the actual symbol chain. This feature is used when generating Macro PDF417. Some applications require the segment count to be set for identifying the last bar code in the symbol chain.

See also:
BCGet_PDF417_SegLast() BCSet_PDF417_SegCount() \param[in] pBarCode Pointer to barcode structure. \param[in] bSegLast Is last segment.
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_SenderA ( t_BarCode * pBarCode,
LPCSTR szSender )

Sets Macro PDF417 Sender (optional). Specifies sender (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure. \param[in] szSender Sender (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_SenderW ( t_BarCode * pBarCode,
LPCWSTR szSender )

Sets Macro PDF417 Sender (optional). Specifies sender (alphanumeric, variable length field)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCGet_PDF417_Sender() \param[in] pBarCode Pointer to barcode structure. \param[in] szSender Sender (reset to default = null).
Return values:
ERRCODE   ErrOk (0) in case of success. Non-zero if error occurred. ----------------------------------------------------------------------------.

ERRCODE BCSet_PDF417_TimeStamp ( t_BarCode * pBarCode,
LONG nTimeStamp )

Sets Macro PDF417 Time Stamp (optional). Specifies time stamp (elapsed time in seconds since January 1, 1970 00:00 GMT) (numeric)
Optional field to be encoded into the Macro PDF control header block. Default: unused.

See also:
BCSet_PDF417_TimeStamp() \param[in] pBarCode Pointer to barcode structure. \param[in] nTimeStamp Time stamp (-1 ... reset to 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