errorapi.cpp File Reference

Public API functions for error handling. More...


Functions

VOID BCGetErrorTextA (ERRCODE eCode, LPSTR szText, size_t nSize)
 Returns error text to given error code. Returns the corresponding error text for a given error code. The returned string will be null-terminated.
Note:
WINDOWS only \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.


VOID BCGetErrorTextW (ERRCODE eCode, LPWSTR szText, size_t nSize)
 Returns error text to given error code. Returns the corresponding error text for a given error code. The returned string will be null-terminated.
Note:
WINDOWS only \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.


INT _GetInvalidDataPosExt ( t_BarCode* pBarCode, LPBOOL pbFormat, LPINT pnPosInFormat )
VOID BCGetErrorTextExtA (t_BarCode* pBarCode, ERRCODE eCode, LPSTR szText, size_t nSize)
 Returns extended error text to given error code. Returns the detailed error text for a given error code. The returned string will be null-terminated and contains the error code, the error description and the source of the error (character position) if available.
Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure. \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.


VOID BCGetErrorTextExtW (t_BarCode* pBarCode, ERRCODE eCode, LPWSTR szText, size_t nSize)
 Returns extended error text to given error code. Returns the detailed error text for a given error code. The returned string will be null-terminated and contains the error code, the error description and the source of the error (character position) if available.
Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure. \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.


INT BCGetInvalidDataPos (t_BarCode* pBarCode)
 Gets position of invalid character in input data. If BCCheck() or BCCreate() fails, this function allows you to determine the position of the first invalid character within the barcode text (see BCSetText()). Note: The returned position may not be accurate when using Escape Sequences in the input data. \param[in] pBarCode Pointer to barcode structure.
Return values:
INT   Zero-based index of invalid character. -1 if not available ----------------------------------------------------------------------------.


Detailed Description

Public API functions for error handling.

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

VOID BCGetErrorTextA ( ERRCODE eCode,
LPSTR szText,
size_t nSize )

Returns error text to given error code. Returns the corresponding error text for a given error code. The returned string will be null-terminated.

Note:
WINDOWS only \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.

VOID BCGetErrorTextExtA ( t_BarCode * pBarCode,
ERRCODE eCode,
LPSTR szText,
size_t nSize )

Returns extended error text to given error code. Returns the detailed error text for a given error code. The returned string will be null-terminated and contains the error code, the error description and the source of the error (character position) if available.

Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure. \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.

VOID BCGetErrorTextExtW ( t_BarCode * pBarCode,
ERRCODE eCode,
LPWSTR szText,
size_t nSize )

Returns extended error text to given error code. Returns the detailed error text for a given error code. The returned string will be null-terminated and contains the error code, the error description and the source of the error (character position) if available.

Note:
Call after BCCreate() \param[in] pBarCode Pointer to barcode structure. \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.

VOID BCGetErrorTextW ( ERRCODE eCode,
LPWSTR szText,
size_t nSize )

Returns error text to given error code. Returns the corresponding error text for a given error code. The returned string will be null-terminated.

Note:
WINDOWS only \param[in] eCode Error code. \param[in, out] szText Error text buffer. \param[in] nSize Buffer size of szText. ----------------------------------------------------------------------------.

INT BCGetInvalidDataPos ( t_BarCode * pBarCode )

Gets position of invalid character in input data. If BCCheck() or BCCreate() fails, this function allows you to determine the position of the first invalid character within the barcode text (see BCSetText()). Note: The returned position may not be accurate when using Escape Sequences in the input data. \param[in] pBarCode Pointer to barcode structure.

Return values:
INT   Zero-based index of invalid character. -1 if not available ----------------------------------------------------------------------------.

INT _GetInvalidDataPosExt ( t_BarCode * pBarCode,
LPBOOL pbFormat,
LPINT pnPosInFormat ) [static]

© 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