iDRS™ SDK 16
Loading...
Searching...
No Matches
CBarcodeContext_interface.h
Go to the documentation of this file.
1
7#ifndef CBARCODECONTEXT_INTERFACE_H
8
9#define CBARCODECONTEXT_INTERFACE_H
10
11#include "CObjPtr_interface.h"
12#include "ArrayDefinitions_interface.h"
13
14#include "idrs_common.h"
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
26CBarcodeContext CBarcodeContext_Create(idrs_exception *pargException);
27
39CBarcodeContext CBarcodeContext_Create2(enum BarcodeType const evBarcodeType, idrs_exception *pargException);
40
49CBarcodeContext CBarcodeContext_Create3(const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException);
50
60void CBarcodeContext_SetBarcodeTypes(CBarcodeContext argCBarcodeContext, const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException);
61
69BarcodeTypeArray CBarcodeContext_GetBarcodeTypes(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
70
78IDRS_UINT CBarcodeContext_GetMinimumPixelsHeight(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
79
87void CBarcodeContext_SetMinimumPixelsHeight(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumPixelsHeight, idrs_exception *pargException);
88
96IDRS_UINT CBarcodeContext_GetMaximumPixelsHeight(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
97
105void CBarcodeContext_SetMaximumPixelsHeight(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumPixelsHeight, idrs_exception *pargException);
106
114IDRS_UINT CBarcodeContext_GetMinimumSymbolsLength(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
115
123void CBarcodeContext_SetMinimumSymbolsLength(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumSymbolsLength, idrs_exception *pargException);
124
132IDRS_UINT CBarcodeContext_GetMaximumSymbolsLength(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
133
141void CBarcodeContext_SetMaximumSymbolsLength(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumSymbolsLength, idrs_exception *pargException);
142
150BarcodeEncodingArray CBarcodeContext_GetDetectedEncodings(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
151
159void CBarcodeContext_SetDetectedEncodings(CBarcodeContext argCBarcodeContext, const BarcodeEncodingArray argBarcodeEncodingArray, idrs_exception *pargException);
160
168IDRS_BOOL CBarcodeContext_GetStopOnFirstResult(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
169
175void CBarcodeContext_SetStopOnFirstResult(CBarcodeContext argCBarcodeContext, IDRS_BOOL const bStopOnFirstResult, idrs_exception *pargException);
176
187BarcodeTypeArray CBarcodeContext_GetRecommendedBarcodeTypes(idrs_exception *pargException);
188
196void CBarcodeContext_Destroy(CBarcodeContext argCBarcodeContext, idrs_exception *pargException);
197
198#ifdef __cplusplus
199}
200#endif /* __cplusplus */
201
202#endif /* CBARCODECONTEXT_INTERFACE_H */
ArrayDefinitions_interface.h
Interface for ArrayDefinitions wrapper.
BarcodeType
BarcodeType
Barcode types recognized by iDRS SDK.
Definition BarcodeType_interface.h:20
CBarcodeContext_GetDetectedEncodings
BarcodeEncodingArray CBarcodeContext_GetDetectedEncodings(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the array of barcode encodings to detect.
CBarcodeContext_Destroy
void CBarcodeContext_Destroy(CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Destroys a CBarcodeContext handle.
CBarcodeContext_SetMinimumSymbolsLength
void CBarcodeContext_SetMinimumSymbolsLength(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumSymbolsLength, idrs_exception *pargException)
Set the minimum number of symbols required to validate a 1D barcode candidate.
CBarcodeContext_SetDetectedEncodings
void CBarcodeContext_SetDetectedEncodings(CBarcodeContext argCBarcodeContext, const BarcodeEncodingArray argBarcodeEncodingArray, idrs_exception *pargException)
Set the array of barcode encodings to detect.
CBarcodeContext_GetMinimumSymbolsLength
IDRS_UINT CBarcodeContext_GetMinimumSymbolsLength(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the minimum number of symbols required to validate a 1D barcode candidate.
CBarcodeContext_Create3
CBarcodeContext CBarcodeContext_Create3(const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException)
Create creates a barcode recognition context to recognize the given barcode types.
CBarcodeContext_Create2
CBarcodeContext CBarcodeContext_Create2(enum BarcodeType const evBarcodeType, idrs_exception *pargException)
Create creates a barcode recognition context to recognize the given barcode type.
CBarcodeContext_GetBarcodeTypes
BarcodeTypeArray CBarcodeContext_GetBarcodeTypes(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Gets the barcode types set.
CBarcodeContext_SetMinimumPixelsHeight
void CBarcodeContext_SetMinimumPixelsHeight(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumPixelsHeight, idrs_exception *pargException)
Set the minimum bar height required to validate a 1D barcode candidate.
CBarcodeContext_SetMaximumPixelsHeight
void CBarcodeContext_SetMaximumPixelsHeight(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumPixelsHeight, idrs_exception *pargException)
Set the maximum bar height required to validate a 1D barcode candidate.
CBarcodeContext_SetStopOnFirstResult
void CBarcodeContext_SetStopOnFirstResult(CBarcodeContext argCBarcodeContext, IDRS_BOOL const bStopOnFirstResult, idrs_exception *pargException)
Set the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.
CBarcodeContext_SetBarcodeTypes
void CBarcodeContext_SetBarcodeTypes(CBarcodeContext argCBarcodeContext, const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException)
SetBarcodeTypes sets the barcode types to look for.
CBarcodeContext_GetRecommendedBarcodeTypes
BarcodeTypeArray CBarcodeContext_GetRecommendedBarcodeTypes(idrs_exception *pargException)
Gets a CBarcodeSet object populated with the barcode types recommended for most barcode recognition w...
CBarcodeContext_GetStopOnFirstResult
IDRS_BOOL CBarcodeContext_GetStopOnFirstResult(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.
CBarcodeContext_SetMaximumSymbolsLength
void CBarcodeContext_SetMaximumSymbolsLength(CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumSymbolsLength, idrs_exception *pargException)
Set the maximum number of symbols required to validate a 1D barcode candidate.
CBarcodeContext_Create
CBarcodeContext CBarcodeContext_Create(idrs_exception *pargException)
Create creates a barcode recognition context. The context is initialized to detect all recommended ba...
CBarcodeContext_GetMinimumPixelsHeight
IDRS_UINT CBarcodeContext_GetMinimumPixelsHeight(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the minimum bar height required to validate a 1D barcode candidate.
CBarcodeContext_GetMaximumSymbolsLength
IDRS_UINT CBarcodeContext_GetMaximumSymbolsLength(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the maximum number of symbols required to validate a 1D barcode candidate.
CBarcodeContext_GetMaximumPixelsHeight
IDRS_UINT CBarcodeContext_GetMaximumPixelsHeight(const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
Get the maximum bar height required to validate a 1D barcode candidate.
CObjPtr_interface.h
Interface for CObjPtr wrapper.
CBarcodeContext
The CBarcodeContext class manages a barcode recognition context.
idrs_common.h
IDRS_BOOL
IDRS_INT IDRS_BOOL
A Boolean value.
Definition idrsstd_interface.h:37
IDRS_UINT
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27