dotcodeapi.cpp File Reference

Public API functions for DotCode. More...


Functions

e_DCSizeMode BCGet_DotCode_SizeMode (t_BarCode* pBarCode)
 Gets size mode of DotCode symbol. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").
See also:
BCGet_DotCode_Size(), BCSet_DotCode_Size() \param[in] pBarCode Pointer to barcode structure.
Return values:
eDCSm_Default   No value set. This is the default. Ratio between columns and rows is "3:2".
e_DCSizeMode   Otherwise ----------------------------------------------------------------------------.


LPCSTR BCGet_DotCode_SizeA (t_BarCode* pBarCode)
 Gets the current DotCode size. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").
See also:
BCSet_DotCode_Size(), BCGet_DotCode_SizeMode(), \param[in] pBarCode Pointer to barcode structure.
Return values:
\0   No size. This is the default
LPCSTR   Otherwise ----------------------------------------------------------------------------.


LPCWSTR BCGet_DotCode_SizeW (t_BarCode* pBarCode)
 Gets the current DotCode size. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").
See also:
BCSet_DotCode_Size(), BCGet_DotCode_SizeMode(), \param[in] pBarCode Pointer to barcode structure.
Return values:
\0   No size. This is the default
LPCSTR   Otherwise ----------------------------------------------------------------------------.


Detailed Description

Public API functions for DotCode.

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_DotCode_SizeA ( t_BarCode * pBarCode )

Gets the current DotCode size. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").

See also:
BCSet_DotCode_Size(), BCGet_DotCode_SizeMode(), \param[in] pBarCode Pointer to barcode structure.
Return values:
\0   No size. This is the default
LPCSTR   Otherwise ----------------------------------------------------------------------------.

e_DCSizeMode BCGet_DotCode_SizeMode ( t_BarCode * pBarCode )

Gets size mode of DotCode symbol. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").

See also:
BCGet_DotCode_Size(), BCSet_DotCode_Size() \param[in] pBarCode Pointer to barcode structure.
Return values:
eDCSm_Default   No value set. This is the default. Ratio between columns and rows is "3:2".
e_DCSizeMode   Otherwise ----------------------------------------------------------------------------.

LPCWSTR BCGet_DotCode_SizeW ( t_BarCode * pBarCode )

Gets the current DotCode size. Returns currently adjusted value. The meaning of the size value depends on the current size mode: - eDCSm_Default: the size value is ignored. The ratio between width and height is "3:2". - eDCSm_RatioWidthHeight: the size value contains the ratio between width and height ("w:h"). - eDCSm_FixedWidth: the size value contains the width in number of dots. - eDCSm_FixedHeight: the size value contains the height in number of dots. - eDCSm_FixedWidthHeight: the size value contains the width and height in number of dots ("wxh").

See also:
BCSet_DotCode_Size(), BCGet_DotCode_SizeMode(), \param[in] pBarCode Pointer to barcode structure.
Return values:
\0   No size. This is the default
LPCSTR   Otherwise ----------------------------------------------------------------------------.

© 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