CBarcodeResultItem Class
The CBarcodeResultItem class represents a barcode result item decoded by barcode reader engine. It is derived from CCapturedResultItem.
Definition
Namespace: dynamsoft::dbr
Assembly: DynamsoftBarcodeReader
Inheritance: CCapturedResultItem -> CBarcodeResultItem
class CBarcodeResultItem : public CCapturedResultItem
Methods
| Method | Description |
|---|---|
GetFormat |
Gets the format of the decoded barcode result. |
GetFormatString |
Gets the format string of the decoded barcode result. |
GetText |
Gets the text result of the decoded barcode. |
GetBytes |
Gets the text bytes of the decoded barcode result. |
GetBytesLength |
Gets the text length of the decoded barcode result. |
GetLocation |
Gets the location of the decoded barcode in a quadrilateral. |
GetConfidence |
Gets the confidence of the decoded barcode result. |
GetAngle |
Gets the angle of the decoded barcode result. |
GetModuleSize |
Gets the module size of the decoded barcode result. |
GetDetails |
Gets the details of the decoded barcode result. |
IsDPM |
Gets whether the decoded barcode is a DPM code. |
IsMirrored |
Gets whether the decoded barcode is a mirrored barcode. |
SetLocation |
Set the location of the barcode item. |
GetECISegmentsCount |
Gets the number of ECI segments in the barcode. |
GetECISegment |
Gets the ECI segment at the specified index. |
| Methods Inherited from CCapturedResultItem: | |
GetType |
Gets the type of the captured result item. |
GetReferenceItem |
Gets a pointer to the referenced item in the captured result. |
GetTargetROIDefName |
Gets the name of the target ROI definition. |
GetTaskName |
Gets the name of the task. |
Retain |
Increases the reference count of the CCapturedResultItem object. |
Release |
Decreases the reference count of the CCapturedResultItem object. |
Clone |
Clone the captured result item. |
GetFormat
It is used to get the format of the decoded barcode result.
virtual BarcodeFormat GetFormat() const = 0;
Return value
Returns the format of the decoded barcode result.
See Also
GetFormatString
It is used to get the format string of the decoded barcode result.
virtual const char* GetFormatString() const = 0;
Return value
Returns the format string of the decoded barcode result.
GetText
It is used to get the text result of the decoded barcode.
virtual const char* GetText() const = 0;
Return value
Returns the text result of the decoded barcode.
Remarks
The text result is returned in UTF-8 encoding. The SDK will automatically attempt to detect and convert the barcode bytes to UTF-8 based on ECI information or common character encodings.
If the returned text contains unexpected characters, it may indicate that the automatic encoding detection did not match the actual encoding of the barcode data. In this case, you should use GetBytes to retrieve the raw byte data and convert it to the appropriate character encoding yourself.
GetBytes
It is used to get the text bytes of the decoded barcode result.
virtual unsigned char* GetBytes() const = 0;
Return value
Returns the text bytes of the decoded barcode result.
GetBytesLength
It is used to get the text bytes length of the decoded barcode result.
virtual int GetBytesLength() const = 0;
Return value
Returns the text bytes length of the decoded barcode result.
GetLocation
It is used to get the location of the decoded barcode in a quadrilateral.
virtual CQuadrilateral GetLocation() const = 0;
Return value
Returns the location of the decoded barcode in a quadrilateral.
See Also
GetConfidence
It is used to get the confidence of the decoded barcode result.
virtual int GetConfidence() const = 0;
Return value
Returns the confidence of the decoded barcode result.
GetAngle
It is used to get the angle of the decoded barcode result.
virtual int GetAngle() const = 0;
Return value
Returns the angle of the decoded barcode result.
See Also
How the angle is calculated for different barcode types
GetModuleSize
It is used to get the module size of the decoded barcode result.
virtual int GetModuleSize() const = 0;
Return value
Returns the module size of the decoded barcode result.
GetDetails
It is used to get the details of the decoded barcode result.
virtual const CBarcodeDetails* GetDetails() const = 0;
Return value
Returns the details of the decoded barcode result.
See Also
IsDPM
It is used to get whether the decoded barcode is a DPM code.
virtual bool IsDPM() const = 0;
Return value
Returns whether the decoded barcode is a DPM code.
IsMirrored
It is used to get whether the decoded barcode is mirrored.
virtual bool IsMirrored() const = 0;
Return value
Returns whether the decoded barcode is mirrored.
SetLocation
Set the location of the barcode item.
virtual int SetLocation(const CQuadrilateral& location) = 0;
Parameters
[in] location The location of the barcode item.
Return value
Returns an error code. Zero indicates success.
See Also
GetECISegmentsCount
Gets the number of ECI segments in the barcode.
virtual int GetECISegmentsCount() const = 0;
Return value
Returns the count of ECI segments. Returns 0 if no ECI information is present.
Remarks
Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.
GetECISegment
Gets the ECI segment at the specified index.
virtual const CECISegment* GetECISegment(int index) const = 0;
Parameters
[in] index The zero-based index of the ECI segment to retrieve.
Return value
Returns a pointer to the CECISegment object, or NULL if the index is out of range.
See Also
Remarks
Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.
Yes
No