Barcode (CVCBarcode.dll) 14.1
Functions
Configurations

Functions

CVC_BC_CONFIG CvcBcCreateConfiguration (BOOL all_barcodes)
 This function creates a new configuration and returns its handle. More...
 
void CvcBcDeleteConfiguration (CVC_BC_CONFIG config)
 This function deletes an existing configuration generated using CvcBcCreateConfiguration, thus freeing the occupied memory space. More...
 
void CvcBcGetCodePositionCheck (CVC_BC_CONFIG config, BOOL *active)
 This function sets all parameters for the Code Position Check. More...
 
void CvcBcGetTimeLimit (CVC_BC_CONFIG config, short *time_limit)
 This function reads the maximum time in milliseconds available for an evaluation when using the configuration config. More...
 
short CvcBcLoadConfiguration (CVC_BC_CONFIG config, LPSTR filename)
 This function reads the configuration data from the file filename into the configuration config. More...
 
short CvcBcSaveConfiguration (CVC_BC_CONFIG config, LPSTR filename)
 This function writes the data from the configuration config to the file filename. More...
 
short CvcBcSetCodePositionCheck (CVC_BC_CONFIG config, BOOL active)
 This function sets all parameters for the Code Position Check. More...
 
void CvcBcSetTimeLimit (CVC_BC_CONFIG config, short time_limit)
 This function sets the maximum evaluation time for the decoding of a barcode. More...
 

Detailed Description

Function Documentation

◆ CvcBcCreateConfiguration()

CVC_BC_CONFIG CvcBcCreateConfiguration ( BOOL  all_barcodes)

This function creates a new configuration and returns its handle.

Attention
If a generated configuration is no longer required, it should be deleted using the CvcBcDeleteConfiguration function in order to free up the occupied memory space.
Parameters
[in]all_barcodesSpecifies whether all or no barcodes are to be initially permitted in this configuration (CVC_BC_ALLOW_ALL or CVC_BC_DENY_ALL).
Returns
Returns the handle to the new configuration. If an error occurs, the handle is negative. A possible error is CVC_BC_NO_MEMORY.
Supported platforms:
Win32
Win64

◆ CvcBcDeleteConfiguration()

void CvcBcDeleteConfiguration ( CVC_BC_CONFIG  config)

This function deletes an existing configuration generated using CvcBcCreateConfiguration, thus freeing the occupied memory space.

Parameters
[in]configHandle to the configuration to be deleted.
Supported platforms:
Win32
Win64

◆ CvcBcGetCodePositionCheck()

void CvcBcGetCodePositionCheck ( CVC_BC_CONFIG  config,
BOOL *  active 
)

This function sets all parameters for the Code Position Check.

Note
An edge can have its coordinates outside the image borders in case the barcode is incomplete
Parameters
[in]configHandle to the configuration or NULL to use the default configuration.
[out]activeEvaluate / don't evaluate evaluate code position check.

The parameter active enables and disables the code position check configuration config. Specifying TRUE enables and FALSE disables the code position check.
Supported platforms:
Win32
Win64
Related Topics:
CvcBcSetCodePositionCheck

◆ CvcBcGetTimeLimit()

void CvcBcGetTimeLimit ( CVC_BC_CONFIG  config,
short *  time_limit 
)

This function reads the maximum time in milliseconds available for an evaluation when using the configuration config.

Parameters
[in]configHandle to the configuration, or NULL to use the default configuration.
[out]time_limitMaximum decoding time in milliseconds.
Supported platforms:
Win32
Win64

◆ CvcBcLoadConfiguration()

short CvcBcLoadConfiguration ( CVC_BC_CONFIG  config,
LPSTR  filename 
)

This function reads the configuration data from the file filename into the configuration config.

Attention
If the file exists but does not contain configuration data, no error is reported. Instead, the configuration is filled with default values.
Parameters
[out]configHandle to the configuration which is to be read from the file. Note that the handle passed here needs to have been allocated first with a call to CvcBcCreateConfiguration.
[in]filenameName of the file, possibly with path specification.
Returns
CVC_BC_NO_ERROR on success, otherwise CVC_BC_FILE_NOT_FOUND.
Supported platforms:
Win32
Win64

◆ CvcBcSaveConfiguration()

short CvcBcSaveConfiguration ( CVC_BC_CONFIG  config,
LPSTR  filename 
)

This function writes the data from the configuration config to the file filename.

The data is stored in an ASCII format which is based on the format of the Windows INI files. If necessary, it can be edited using a simple ASCII editor such as NOTEPAD.EXE.

Attention
If the file already exists, it is overwritten.
Parameters
[in]configHandle to the configuration which is to be written
from the file or NULL to use the default configuration.
[in]filenameName of the file, possibly with path specification.
Returns
CVC_BC_NO_ERROR on success, otherwise CVC_BC_FILE_NOT_WRITEABLE.
Supported platforms:
Win32
Win64

◆ CvcBcSetCodePositionCheck()

short CvcBcSetCodePositionCheck ( CVC_BC_CONFIG  config,
BOOL  active 
)

This function sets all parameters for the Code Position Check.

Note
An edge can have its coordinates outside the image borders in case the barcode is incomplete
Parameters
[in]configHandle to the configuration or NULL to use the default configuration.
[in]activeEvaluate / don't evaluate evaluate code position check.

The parameter active enables and disables the code position check configuration config. Specifying TRUE enables and FALSE disables the code position check.
Returns
CVC_BC_NO_ERROR on success, otherwise CVC_BC_PARAMETER_WARNING.
Supported platforms:
Win32
Win64
Related Topics:
CvcBcGetCodePositionCheck

◆ CvcBcSetTimeLimit()

void CvcBcSetTimeLimit ( CVC_BC_CONFIG  config,
short  time_limit 
)

This function sets the maximum evaluation time for the decoding of a barcode.

It sets the maximum time which may be required for evaluation when using the configuration config. When the configuration cannot be concluded in this time, the function CvcBcDecodeBarcode returns the value 0 (no code decoded), even if the code is present in the image.

For time measurement, Barcode uses the function clock() from the standard C library. On PC systems this generally has temporary resolution of approximately 55 ms. There is therefore no point specifying values less than 55 ms. On high performance PC systems, the evaluation time is generally below 50 ms. Thus this function is only of use in connection with slow systems.

The actual decoding time may deviate from the specified time by plus/minus 55 ms.

When configuration is generated, the value of 1000 milliseconds is entered as the default decoding time. This value should always be achieved on modern PC systems.

Parameters
[in]configHandle to the configuration, or NULL to use the default configuration.
[in]time_limitMaximum decoding time in milliseconds.
Supported platforms:
Win32
Win64