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

Interface for CBarcodePageParams wrapper. More...

Go to the source code of this file.

Functions

CBarcodePageParams CBarcodePageParams_Create (idrs_exception *pargException)
 Creates a new instance of this class.
 
CBarcodePageParams CBarcodePageParams_Create2 (const CBarcodeContext argBarcodeContext, idrs_exception *pargException)
 Creates a new instance of this class and sets the associated.
 
CBarcodeContext CBarcodePageParams_GetContext (const CBarcodePageParams argCBarcodePageParams, idrs_exception *pargException)
 Gets the associated barcode context.
 
void CBarcodePageParams_SetContext (CBarcodePageParams argCBarcodePageParams, const CBarcodeContext argContext, idrs_exception *pargException)
 Sets the associated barcode context.
 
void CBarcodePageParams_Destroy (CBarcodePageParams argCBarcodePageParams, idrs_exception *pargException)
 Destroys a CBarcodePageParams handle.
 

Detailed Description

Interface for CBarcodePageParams wrapper.

Function Documentation

◆ CBarcodePageParams_Create()

CBarcodePageParams CBarcodePageParams_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

◆ CBarcodePageParams_Create2()

CBarcodePageParams CBarcodePageParams_Create2 ( const CBarcodeContext  argBarcodeContext,
idrs_exception *  pargException 
)

Creates a new instance of this class and sets the associated.

See also
CBarcodeContext
Parameters
argBarcodeContextBarcode context to set
pargExceptionPointer to exception structure that will be filled if an exception occurs

By default the associated barcode context enables all available barcode types (license permitting)

Remarks
Instances created by this method can also be provided to CBarcodeParams methods

◆ CBarcodePageParams_Destroy()

void CBarcodePageParams_Destroy ( CBarcodePageParams  argCBarcodePageParams,
idrs_exception *  pargException 
)

Destroys a CBarcodePageParams handle.

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

◆ CBarcodePageParams_GetContext()

CBarcodeContext CBarcodePageParams_GetContext ( const CBarcodePageParams  argCBarcodePageParams,
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
argCBarcodePageParamsCBarcodePageParams handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CBarcodePageParams_SetContext()

void CBarcodePageParams_SetContext ( CBarcodePageParams  argCBarcodePageParams,
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
argCBarcodePageParamsCBarcodePageParams handle
argContextAssociated barcode context
pargExceptionPointer to exception structure that will be filled if an exception occurs