DSBarcodeScanResult
DSBarcodeScanResult
is a result class that contains all decoded barcodes and their associated info from a single scan.
Definition
Assembly: DynamsoftBarcodeReaderBundle.xcframework
- Objective-C
- Swift
@interface DSBarcodeScanResult : NSObject
class BarcodeScanResult : NSObject
Properties
Property | Type | Description |
---|---|---|
barcodes |
NSArray<DSBarcodeResultItem*> * | An array of DSBarcodeResultItem , which is the basic item of the captured results. |
resultStatus |
DSResultStatus | The status of the BarcodeScanResult , which can indicate success or failure. |
errorCode |
NSInteger | The error code should something go wrong during the barcode recognition process. |
errorString |
NSString * | The error message associated with the error code should something go wrong during the barcode recognition process. |
barcodes
An array of DSBarcodeResultItem
, which is the basic item of the captured results and is the most basic unit of the captured results.
- Objective-C
- Swift
@property (nonatomic, assign, readonly) NSArray<BarcodeResultItem*>* barcodes;
var barcodes: [BarcodeResultItem] {get}
resultStatus
The status of the result, which can be one of finished, canceled or exception.
- Objective-C
- Swift
@property (nonatomic, assign, readonly) DSResultStatus resultStatus;
var resultStatus: ResultStatus {get}
Return Value
The status of the barcode result, of type DSResultStatus.
RS_FINISHED
: The barcode scanning is finished.RS_CANCELED
: The barcode scanning activity is closed before the process is finished.RS_EXCEPTION
: Failed to start barcode scanning or an error occurs when scanning the barcodes.
errorCode
The error code should something go wrong during the barcode recognition process.
- Objective-C
- Swift
@property (nonatomic, assign, readonly) NSInteger errorCode;
var errorCode: Int { get }
Return Value
An integer representing a DSError
.
errorString
The error message associated with the error code should something go wrong during the barcode recognition process.
- Objective-C
- Swift
@property (nonatomic, assign, readonly) NSString * errorMessage;
var errorMessage: String? { get }