BarcodeScannerManager is where all barcode scanners are managed and where a user application or library can open an instance of the driver. This should be the first class accessed in this library by a user application. More...

Inheritance diagram for Motorola.Snapi.BarcodeScannerManager:

Public Member Functions
void	Close ()

List< IMotorolaBarcodeScanner >	GetDevices ()
	Find all connected devices More...

bool	Open ()
	Opens an application instance from the user application or user library. More...

void	RegisterForEvents (params EventType[] events)
	Registers the API for the given event types. More...

void	UnRegisterForEvents (params EventType[] events)
	Unregisters the API for the given event types. More...

void	Dispose ()

Static Public Attributes
static readonly BarcodeScannerManager	Instance = new BarcodeScannerManager()

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
Keyboard	Keyboard `[get]`

string	DriverVersion `[get]`
	Version number of the CoreScanner driver. More...

IEnumerable< EventType >	RegisteredEvents `[get]`

Events
EventHandler< BarcodeScanEventArgs >	DataReceived
	Invoked when bar code data is received by a scanner. More...

EventHandler< PnpEventArgs >	ScannerAttached
	Invoked when a scanner is attached by plugging in the usb or after a reboot. More...

EventHandler< PnpEventArgs >	ScannerDetached
	Invoked when a scanner is detached. More...

EventHandler< ImageEventArgs >	ImageReceived
	Invoked when a scanner captures an image. More...

EventHandler< VideoEventArgs >	VideoReceived
	Invoked when a scanner captures video. More...

EventHandler< FlashStartEventArgs >	FlashSessionStarted
	Invoked when a firmware update session has begun. More...

EventHandler< DownloadEventArgs >	DownloadStarted
	Invoked when a firmware download has begun. More...

EventHandler< DownloadEventArgs >	BlockFinished
	Invoked when a record finishes downloading to update on the progress. More...

EventHandler< DownloadEventArgs >	DownloadEnded
	Invoked when a component download ends More...

EventHandler< FirmwareEventArgs >	FlashSessionEnded
	Invoked when a firmware download session ends. More...

EventHandler< FirmwareEventArgs >	FirmwareStatusOrErrorReceived
	Invoked when a status message or error message is received relating to firmware update. More...

EventHandler< ScannerEventArgs >	DecodeModeEnabled
	Invoked when a scanner's operation mode is changed to decode barcode mode. More...

EventHandler< ScannerEventArgs >	SnapshotModeEnabled
	Invoked when a scanner's operation mode is changed to snapshot mode. More...

EventHandler< ScannerEventArgs >	VideoModeEnabled
	Invoked when a scanner's operation mode is changed to video mode. More...

EventHandler< IoEventArgs >	ApplicationBlocked
	Invoked when another application attempts to access a scanner that has been exclusively claimed by this application. More...

Detailed Description

BarcodeScannerManager is where all barcode scanners are managed and where a user application or library can open an instance of the driver. This should be the first class accessed in this library by a user application.

To start using this library you will need to do the following.

First open an instance of the CoreScanner driver.

BarcodeScannerManager.Instance.Open();

Now you can register for whatever events you want to listen for in your application.

For example:

            BarcodeScannerManager.Instance.RegisterForEvents(
                EventType.Barcode,
                EventType.Pnp,
                EventType.Image,
                EventType.Other,
                EventType.Rmd
                );

If you need to unregister for an event..

            BarcodeScannerManager.Instance.UnRegisterForEvents(
                EventType.Barcode,
                EventType.Pnp,
                EventType.Image,
                EventType.Other,
                EventType.Rmd
                );

Now you can use

_scanners = BarcodeScannerManager.Instance.GetDevices();

to get a list containing an IMotorolaBarcodeScanner object for each of your scanners from which you can perform scanner specific tasks.

Adding a handler for an event is simply

BarcodeScannerManager.Instance.DataReceived += OnDataReceived;

Member Function Documentation

List<IMotorolaBarcodeScanner> Motorola.Snapi.BarcodeScannerManager.GetDevices ( )

Find all connected devices

Returns: A list of IMotorolaSnapiScanner

bool Motorola.Snapi.BarcodeScannerManager.Open ( )

Opens an application instance from the user application or user library.

Returns: True if opened successfully

void Motorola.Snapi.BarcodeScannerManager.RegisterForEvents ( params EventType[] events )

Registers the API for the given event types.

Parameters

events Events to register for.

void Motorola.Snapi.BarcodeScannerManager.UnRegisterForEvents ( params EventType[] events )

Unregisters the API for the given event types.

Parameters

events Events to unregister from.

Property Documentation

string Motorola.Snapi.BarcodeScannerManager.DriverVersion

get

Version number of the CoreScanner driver.

Event Documentation

EventHandler<IoEventArgs> Motorola.Snapi.BarcodeScannerManager.ApplicationBlocked

Invoked when another application attempts to access a scanner that has been exclusively claimed by this application.

EventHandler<DownloadEventArgs> Motorola.Snapi.BarcodeScannerManager.BlockFinished

Invoked when a record finishes downloading to update on the progress.

EventHandler<BarcodeScanEventArgs> Motorola.Snapi.BarcodeScannerManager.DataReceived

Invoked when bar code data is received by a scanner.

EventHandler<ScannerEventArgs> Motorola.Snapi.BarcodeScannerManager.DecodeModeEnabled

Invoked when a scanner's operation mode is changed to decode barcode mode.

EventHandler<DownloadEventArgs> Motorola.Snapi.BarcodeScannerManager.DownloadEnded

Invoked when a component download ends

EventHandler<DownloadEventArgs> Motorola.Snapi.BarcodeScannerManager.DownloadStarted

Invoked when a firmware download has begun.

EventHandler<FirmwareEventArgs> Motorola.Snapi.BarcodeScannerManager.FirmwareStatusOrErrorReceived

Invoked when a status message or error message is received relating to firmware update.

EventHandler<FirmwareEventArgs> Motorola.Snapi.BarcodeScannerManager.FlashSessionEnded

Invoked when a firmware download session ends.

EventHandler<FlashStartEventArgs> Motorola.Snapi.BarcodeScannerManager.FlashSessionStarted

Invoked when a firmware update session has begun.

EventHandler<ImageEventArgs> Motorola.Snapi.BarcodeScannerManager.ImageReceived

Invoked when a scanner captures an image.

EventHandler<PnpEventArgs> Motorola.Snapi.BarcodeScannerManager.ScannerAttached

Invoked when a scanner is attached by plugging in the usb or after a reboot.

EventHandler<PnpEventArgs> Motorola.Snapi.BarcodeScannerManager.ScannerDetached

Invoked when a scanner is detached.

EventHandler<ScannerEventArgs> Motorola.Snapi.BarcodeScannerManager.SnapshotModeEnabled

Invoked when a scanner's operation mode is changed to snapshot mode.

EventHandler<ScannerEventArgs> Motorola.Snapi.BarcodeScannerManager.VideoModeEnabled

Invoked when a scanner's operation mode is changed to video mode.

EventHandler<VideoEventArgs> Motorola.Snapi.BarcodeScannerManager.VideoReceived

Invoked when a scanner captures video.

The documentation for this class was generated from the following file:

BarcodeScannerManager.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation