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

Interface for CBarcodeZonalSettings wrapper. More...

Go to the source code of this file.

Functions

CBarcodeZonalSettings CBarcodeZonalSettings_Create (idrs_exception *pargException)
 Creates a new instance of this class.
 
CBarcodeContext CBarcodeZonalSettings_GetContext (const CBarcodeZonalSettings argCBarcodeZonalSettings, idrs_exception *pargException)
 Gets the associated barcode context.
 
void CBarcodeZonalSettings_SetContext (CBarcodeZonalSettings argCBarcodeZonalSettings, const CBarcodeContext argContext, idrs_exception *pargException)
 Sets the associated barcode context.
 
CPolygonArray CBarcodeZonalSettings_GetZones (const CBarcodeZonalSettings argCBarcodeZonalSettings, idrs_exception *pargException)
 Gets the array of zones (defined as.
 
void CBarcodeZonalSettings_SetZones (CBarcodeZonalSettings argCBarcodeZonalSettings, const CPolygonArray argZones, idrs_exception *pargException)
 Sets the array of zones (defined as.
 
void CBarcodeZonalSettings_Destroy (CBarcodeZonalSettings argCBarcodeZonalSettings, idrs_exception *pargException)
 Destroys a CBarcodeZonalSettings handle.
 
CBarcodeZonalSettingsArray ArrayInterface_Create_CBarcodeZonalSettingsArray (idrs_exception *pargException)
 Creates a new CBarcodeZonalSettingsArray object.
 

Detailed Description

Interface for CBarcodeZonalSettings wrapper.

Function Documentation

◆ ArrayInterface_Create_CBarcodeZonalSettingsArray()

CBarcodeZonalSettingsArray ArrayInterface_Create_CBarcodeZonalSettingsArray ( idrs_exception *  pargException)

Creates a new CBarcodeZonalSettingsArray object.

Parameters
pargExceptionPointer to exception structure that will be filled if an exception occurs
Returns
The newly created CBarcodeZonalSettingsArray

◆ CBarcodeZonalSettings_Create()

CBarcodeZonalSettings CBarcodeZonalSettings_Create ( idrs_exception *  pargException)

Creates a new instance of this class.

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

◆ CBarcodeZonalSettings_Destroy()

void CBarcodeZonalSettings_Destroy ( CBarcodeZonalSettings  argCBarcodeZonalSettings,
idrs_exception *  pargException 
)

Destroys a CBarcodeZonalSettings handle.

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

◆ CBarcodeZonalSettings_GetContext()

CBarcodeContext CBarcodeZonalSettings_GetContext ( const CBarcodeZonalSettings  argCBarcodeZonalSettings,
idrs_exception *  pargException 
)

Gets the associated barcode context.

The barcode context allows setting the list of barcodes that can be detected by the barcode engine, barcode size range & encodings

Returns
Associated barcode context
Parameters
argCBarcodeZonalSettingsCBarcodeZonalSettings handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodeZonalSettings_GetZones()

CPolygonArray CBarcodeZonalSettings_GetZones ( const CBarcodeZonalSettings  argCBarcodeZonalSettings,
idrs_exception *  pargException 
)

Gets the array of zones (defined as.

See also
CPolygon) where barcode recognition will be executed using the associated context.
Returns
Array of polygons where barcode detection will be run
Parameters
argCBarcodeZonalSettingsCBarcodeZonalSettings handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodeZonalSettings_SetContext()

void CBarcodeZonalSettings_SetContext ( CBarcodeZonalSettings  argCBarcodeZonalSettings,
const CBarcodeContext  argContext,
idrs_exception *  pargException 
)

Sets the associated barcode context.

The barcode context allows setting the list of barcodes that can be detected by the barcode engine, barcode size range & encodings

Parameters
argCBarcodeZonalSettingsCBarcodeZonalSettings handle
argContextAssociated barcode context
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodeZonalSettings_SetZones()

void CBarcodeZonalSettings_SetZones ( CBarcodeZonalSettings  argCBarcodeZonalSettings,
const CPolygonArray  argZones,
idrs_exception *  pargException 
)

Sets the array of zones (defined as.

See also
CPolygon) where barcode recognition will be executed using the associated context.

Setting one or more polygons with coordinates outside the input page/image bounds will trigger an exception during barcode detection.

Parameters
argCBarcodeZonalSettingsCBarcodeZonalSettings handle
argZonesArray of polygons where barcode detection will be run
pargExceptionPointer to exception structure that will be filled if an exception occurs