CDecodedBarcodesResult Class
The CDecodedBarcodesResult
class represents the result of a barcode reading process. It provides access to information about the decoded barcodes, the source image, and any errors that occurred during the barcode reading process.
Definition
Namespace: dynamsoft::dbr
Assembly: DynamsoftBarcodeReader
class CDecodedBarcodesResult
Methods
Method | Description |
---|---|
GetOriginalImageHashId |
Gets the hash ID of the source image. |
GetOriginalImageTag |
Gets the tag of the source image. |
GetItemsCount |
Gets the number of barcode result items in the barcode reading result. |
GetItem |
Gets the barcode result item at the specified index. |
HasItem |
Check if the barcode result item is present in the array. |
RemoveItem |
Remove a specific barcode result item from the result array. |
GetRotationTransformMatrix |
Get the rotation transformation matrix of the original image relative to the rotated image. |
GetErrorCode |
Gets the error code of the barcode reading result, if an error occurred. |
GetErrorString |
Gets the error message of the barcode reading result, if an error occurred. |
Release |
Decreases the reference count of the CDecodedBarcodesResult object. |
Retain |
Increases the reference count of the CDecodedBarcodesResult object. |
operator[] |
Gets a pointer to the CBarcodeResultItem object at the specified index. |
AddItem |
Adds a specific item to the array in the decoded barcodes result. |
GetOriginalImageHashId
Gets the hash ID of the source image.
virtual const char* GetOriginalImageHashId() const = 0;
Return value
Returns a pointer to a null-terminated string containing the hash ID of the source image.
GetOriginalImageTag
Gets the tag of the source image.
virtual const CImageTag* GetOriginalImageTag() const = 0;
Return value
Returns a pointer to a CImageTag object representing the tag of the source image.
See Also
GetItemsCount
Gets the number of decoded barcode items in the barcode reading result.
virtual int GetItemsCount() const = 0;
Return value
Returns the number of decoded barcode items in the barcode reading result.
GetItem
Gets the decoded barcode result item at the specified index.
virtual const CBarcodeResultItem* GetItem(int index) const = 0;
Parameters
[in] index
The zero-based index of the barcode result item to retrieve.
Return value
Returns a pointer to the CBarcodeResultItem object at the specified index.
See Also
HasItem
Check if the barcode result item is present in the array.
bool HasItem(const CBarcodeResultItem* item) const
Parameters
[in] item
The specific item to check.
Return value
Returns a bool value indicating whether the item is present in the array or not.
See Also
RemoveItem
Remove a specific barcode result item from the result array.
int RemoveItem(const CBarcodeResultItem* item)
Parameters
[in] item
The specific item to remove.
Return value
Return value indicating whether the deletion was successful or not.
See Also
GetRotationTransformMatrix
Get the rotation transformation matrix of the original image relative to the rotated image.
void GetRotationTransformMatrix(double matrix[9]) const;
Parameters
[out] matrix
A double array which represents the rotation transform matrix.
GetErrorCode
Gets the error code of the barcode reading result, if an error occurred.
virtual int GetErrorCode() const = 0;
Return value
Returns the error code of the barcode reading result, or 0 if no error occurred.
See Also
GetErrorString
Gets the error message of the barcode reading result, if an error occurred.
virtual const char* GetErrorString() const = 0;
Return value
Returns a pointer to a null-terminated string containing the error message of the barcode reading result, or a pointer to an empty string if no error occurred.
Release
Decreases the reference count of the CDecodedBarcodesResult
object.
virtual void Release() = 0;
Retain
Increases the reference count of the CDecodedBarcodesResult
object.
virtual CDecodedBarcodesResult* Retain() = 0;
Return value
Returns an object of CDecodedBarcodesResult
.
operator[]
Gets a pointer to the CBarcodeResultItem
object at the specified index.
virtual const CBarcodeResultItem* operator[](int index) const = 0;
Parameters
[in] index
The index of the barcode result item to retrieve.
Return value
Returns a pointer to the CBarcodeResultItem
object at the specified index.
See Also
AddItem
Adds a specific item to the array in the parsed result.
virtual int AddItem(const CBarcodeResultItem* item) = 0;
Parameters
[in] item
The specific item to be added.
Return value
Returns an error code. Zero indicates success.
See Also