ScannerBase Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains most of the functionality for support of scanner devices.
public abstract class ScannerBase : Microsoft.PointOfService.BasicServiceObjects.ScannerBasictype ScannerBase = class
inherit ScannerBasicPublic MustInherit Class ScannerBase
Inherits ScannerBasic- Inheritance
Constructors
| ScannerBase() |
Creates an instance of the ScannerBase class. |
Fields
| ExtendedErrorFirmwareBadFile |
Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon) |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| StatisticCommunicationErrorCount |
Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon) |
| StatisticDeviceCategory |
Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticGoodScanCount |
Incremented for each successful scan. (Inherited from Scanner) |
| StatisticHoursPoweredCount |
Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon) |
| StatisticInstallationDate |
Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon) |
| StatisticInterface |
Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon) |
| StatisticManufactureDate |
Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon) |
| StatisticManufacturerName |
Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon) |
| StatisticMechanicalRevision |
Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon) |
| StatisticModelName |
Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon) |
| StatisticSerialNumber |
Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon) |
| StatisticUnifiedPOSVersion |
Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon) |
| StatusPowerOff |
Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon) |
| StatusPowerOffline |
Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon) |
| StatusPowerOffOffline |
Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon) |
| StatusPowerOnline |
Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon) |
| StatusUpdateFirmwareComplete |
Indicates the update firmware process has completed successfully. (Inherited from PosCommon) |
| StatusUpdateFirmwareCompleteDeviceNotRestored |
Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceNeedsFirmware |
Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceOk |
Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnknown |
Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnrecoverable |
Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon) |
| StatusUpdateFirmwareProgress |
Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon) |
| WaitForever |
Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon) |
Properties
| AutoDisable | (Inherited from ScannerBasic) |
| CapCompareFirmwareVersion | (Inherited from ScannerBasic) |
| CapPowerReporting | (Inherited from ScannerBasic) |
| CapStatisticsReporting | (Inherited from ScannerBasic) |
| CapUpdateFirmware | (Inherited from ScannerBasic) |
| CapUpdateStatistics | (Inherited from ScannerBasic) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from ScannerBasic) |
| CommonProperties | (Inherited from ScannerBasic) |
| Compatibility | (Inherited from PosDevice) |
| DataCount | (Inherited from ScannerBasic) |
| DataEventEnabled | (Inherited from ScannerBasic) |
| DecodeData |
When the application sets DecodeData to true, the service object decodes the value of the ScanData property and places the decoded data in the ScanDataLabel and ScanDataType properties. |
| DeviceDescription | (Inherited from ScannerBasic) |
| DeviceEnabled | (Inherited from ScannerBasic) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from ScannerBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| ErrorCount | (Inherited from ScannerBasic) |
| ExternallyClaimed | (Inherited from ScannerBasic) |
| FreezeEvents | (Inherited from ScannerBasic) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Gets a Boolean value that indicates whether the Scanner is an exclusive-use device. (Inherited from Scanner) |
| PowerNotify | (Inherited from ScannerBasic) |
| PowerState | (Inherited from ScannerBasic) |
| Properties |
Contains getters and setters for common and scanner device properties. |
| ScanData |
Holds a byte array of the data read from the scanner. |
| ScanDataLabel |
Holds the decoded bar code label. |
| ScanDataType |
Holds the decoded bar code label type. Possible values are defined by the BarCodeSymbology enumeration. |
| ServiceObjectDescription | (Inherited from ScannerBasic) |
| ServiceObjectVersion | (Inherited from ScannerBasic) |
| State | (Inherited from ScannerBasic) |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
Methods
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | (Inherited from ScannerBasic) |
| ClearInput() | (Inherited from ScannerBasic) |
| ClearInputImpl() | (Inherited from ScannerBasic) |
| ClearInputProperties() |
Resets the values of properties altered by DataEvent or ErrorEvent. |
| Close() | (Inherited from ScannerBasic) |
| CompareFirmwareVersion(String) |
Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon) |
| CreateStatistic(String, Boolean, String) | (Inherited from ScannerBasic) |
| CreateStatistic(String, Boolean) | (Inherited from ScannerBasic) |
| DecodeScanDataLabel(Byte[]) |
A default implementation of DecodeScanDataLabel that returns an empty byte array. |
| DecodeScanDataType(Byte[]) |
A default implementation that returns a value of BarCodeSymbology.Unknown. |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DirectIO(Int32, Int32, Object) |
Used to communicate directly with the Service Object. (Inherited from PosCommon) |
| Dispose() | (Inherited from ScannerBasic) |
| Dispose(Boolean) | |
| FailedScan() |
Called by the service object to have ScannerBase class notify the application that the current scan has failed. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from ScannerBasic) |
| GoodScan(Byte[], BarCodeSymbology, Byte[]) |
Called by the service object to request that ScannerBase class queue a data event containing the scanned data to the application. |
| GoodScan(Byte[]) |
Called by the service object to request that ScannerBase class queue a data event containing the scanned data to the application. |
| IncrementStatistic(String, Int32) | (Inherited from ScannerBasic) |
| IncrementStatistic(String) | (Inherited from ScannerBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. |
| PreFireEvent(DataEventArgs) |
Called prior to the delivery of a DataEvent event to the application. |
| PreFireEvent(DeviceErrorEventArgs) | (Inherited from ScannerBasic) |
| PreFireEvent(DirectIOEventArgs) | (Inherited from ScannerBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from ScannerBasic) |
| QueueEvent(DataEventArgs) | (Inherited from ScannerBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from ScannerBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from ScannerBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from ScannerBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from ScannerBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from ScannerBasic) |
| Release() | (Inherited from ScannerBasic) |
| ResetStatistic(String) | (Inherited from ScannerBasic) |
| ResetStatistics() | (Inherited from ScannerBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from ScannerBasic) |
| ResetStatistics(String[]) | (Inherited from ScannerBasic) |
| RetrieveStatistic(String) | (Inherited from ScannerBasic) |
| RetrieveStatistics() | (Inherited from ScannerBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from ScannerBasic) |
| RetrieveStatistics(String[]) | (Inherited from ScannerBasic) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | (Inherited from ScannerBasic) |
| SetStatisticValue(String, Object) | (Inherited from ScannerBasic) |
| UpdateFirmware(String) |
Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon) |
| UpdateStatistic(String, Object) | (Inherited from ScannerBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from ScannerBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from ScannerBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from ScannerBasic) |
Events
| DataEvent | (Inherited from ScannerBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from ScannerBasic) |
| ErrorEvent | (Inherited from ScannerBasic) |
| StateChangedEvent | (Inherited from ScannerBasic) |
| StatusUpdateEvent | (Inherited from ScannerBasic) |