Objective-C API Reference - Parameter and Runtime Settings Basic Methods

getRuntimeSettings

Get current settings and save them into a iPublicRuntimeSettings struct.

- (iPublicRuntimeSettings* _Nullable)getRuntimeSettings:(NSError* _Nullable * _Nullable)error;

Parameters

[in,out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return value

A DBRPublicRuntimeSettings storing current runtime settings.

Code Snippet

• Objective-C
• Swift

1. DynamsoftBarcodeReader *barcodeReader;
   barcodeReader = [[DynamsoftBarcodeReader alloc] initWithLicense:@"t0260NwAAAHV***************"];
   NSError __autoreleasing * _Nullable error;
   [barcodeReader getRuntimeSettings:&error];
   

2. let error: NSError? = NSError()
   let barcodeReader = DynamsoftBarcodeReader.init(license: "t0260NwAAAHV***************")
   let licenseString = try? barcodeReader.getRuntimeSettings()
   

updateRuntimeSettings

Update runtime settings with a given iPublicRuntimeSettings struct.

- (void)updateRuntimeSettings:(iPublicRuntimeSettings* _Nonnull)settings
                        error:(NSError* _Nullable * _Nullable)error;

Parameters

[in] settings The struct of template settings.
[in,out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Code Snippet

• Objective-C
• Swift

1. DynamsoftBarcodeReader *barcodeReader;
   barcodeReader = [[DynamsoftBarcodeReader alloc] initWithLicense:@"t0260NwAAAHV***************"];
   NSError __autoreleasing * _Nullable error;
   iPublicRuntimeSettings *settings;
   [barcodeReader updateRuntimeSettings:settings error:&error];
   

2. var error: NSError? = NSError()
   let barcodeReader = DynamsoftBarcodeReader.init(license: "t0260NwAAAHV***************")
   let settings = try? barcodeReader.getRuntimeSettings()
   barcodeReader.update(settings, &error)
   

resetRuntimeSettings

Reset all parameters to default values.

- (void)resetRuntimeSettings:(NSError* _Nullable * _Nullable)error;

Parameters

[in,out] error Input a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Code Snippet

• Objective-C
• Swift

1. DynamsoftBarcodeReader *barcodeReader;
   barcodeReader = [[DynamsoftBarcodeReader alloc] initWithLicense:@"t0260NwAAAHV***************"];
   NSError __autoreleasing * _Nullable error;
   [barcodeReader resetRuntimeSettings:&error];
   

2. var error: NSError? = NSError()
   let barcodeReader = DynamsoftBarcodeReader.init(license: "t0260NwAAAHV***************")
   barcodeReader.resetRuntimeSettings(&error)