iDRS™ SDK 16
Loading...
Searching...
No Matches
CBarcodeZonalParams_interface.h File Reference

Interface for CBarcodeZonalParams wrapper. More...

Go to the source code of this file.

Functions

CBarcodeZonalParams CBarcodeZonalParams_Create (idrs_exception *pargException)
 Creates a new instance of this class.
 
CBarcodeZonalSettingsArray CBarcodeZonalParams_GetZonalSettings (const CBarcodeZonalParams argCBarcodeZonalParams, idrs_exception *pargException)
 Gets the configuration for the zones where the barcode detection will be executed.
 
void CBarcodeZonalParams_SetZonalSettings (CBarcodeZonalParams argCBarcodeZonalParams, const CBarcodeZonalSettingsArray argxZonalSettings, idrs_exception *pargException)
 Sets the configuration for the zones where the barcode detection will be executed.
 
void CBarcodeZonalParams_Destroy (CBarcodeZonalParams argCBarcodeZonalParams, idrs_exception *pargException)
 Destroys a CBarcodeZonalParams handle.
 

Detailed Description

Interface for CBarcodeZonalParams wrapper.

Function Documentation

◆ CBarcodeZonalParams_Create()

CBarcodeZonalParams CBarcodeZonalParams_Create ( idrs_exception *  pargException)

Creates a new instance of this class.

Parameters
pargExceptionPointer to exception structure that will be filled if an exception occurs
Remarks
Instances created by this method can also be provided to CBarcodeParams methods

◆ CBarcodeZonalParams_Destroy()

void CBarcodeZonalParams_Destroy ( CBarcodeZonalParams  argCBarcodeZonalParams,
idrs_exception *  pargException 
)

Destroys a CBarcodeZonalParams handle.

Parameters
argCBarcodeZonalParamsCBarcodeZonalParams handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodeZonalParams_GetZonalSettings()

CBarcodeZonalSettingsArray CBarcodeZonalParams_GetZonalSettings ( const CBarcodeZonalParams  argCBarcodeZonalParams,
idrs_exception *  pargException 
)

Gets the configuration for the zones where the barcode detection will be executed.

The barcode detection will run all enabled barcode engines on the specified zones

By default, there will be no zone added to the zones array

Returns
Array containing the configuration for the zones where detection will be run
Parameters
argCBarcodeZonalParamsCBarcodeZonalParams handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodeZonalParams_SetZonalSettings()

void CBarcodeZonalParams_SetZonalSettings ( CBarcodeZonalParams  argCBarcodeZonalParams,
const CBarcodeZonalSettingsArray  argxZonalSettings,
idrs_exception *  pargException 
)

Sets the configuration for the zones where the barcode detection will be executed.

The barcode detection will run all enabled barcode engines on the specified zones

By default, there will be no zone added to the zones array

Parameters
argCBarcodeZonalParamsCBarcodeZonalParams handle
argxZonalSettingsArray containing the configuration for the zones where detection will be run
pargExceptionPointer to exception structure that will be filled if an exception occurs