RFIDScannerBase 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 RFID Scanner devices.
public abstract class RFIDScannerBase : Microsoft.PointOfService.BasicServiceObjects.RFIDScannerBasictype RFIDScannerBase = class
inherit RFIDScannerBasicPublic MustInherit Class RFIDScannerBase
Inherits RFIDScannerBasic- Inheritance
Constructors
| RFIDScannerBase() |
Creates an instance of the RFIDScannerBase class. |
Fields
| ExtendedErrorAntennaFailure |
Indicates if the RF antenna is in a state of failure. (Inherited from RFIDScanner) |
| 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) |
| StatisticFailedTagDisableCount |
Contains the count of failed tag disable attempts. (Inherited from RFIDScanner) |
| StatisticFailedTagLockCount |
Contains the count of failed tag lock attempts. (Inherited from RFIDScanner) |
| StatisticFailedTagWriteCount |
Contains the count of failed tag write attempts. (Inherited from RFIDScanner) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticGoodTagDisableCount |
Contains the count of successful tag disable attempts. (Inherited from RFIDScanner) |
| StatisticGoodTagLockCount |
Contains the count of successful tag lock attempts. (Inherited from RFIDScanner) |
| StatisticGoodTagWriteCount |
Contains the count of successful tag write attempts. (Inherited from RFIDScanner) |
| 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) |
| StatisticTagReadCount |
Contains the count of read tags. (Inherited from RFIDScanner) |
| StatisticUnifiedPOSVersion |
Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon) |
| StatusExcessNoise |
Indicates the RFIDScanner device is experiencing excess noise. (Inherited from RFIDScanner) |
| StatusLowMemory |
Indicates the RFIDScanner device is low on memory. (Inherited from RFIDScanner) |
| 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
Methods
| CheckHealth(HealthCheckLevel) |
Indicates the current health status of the device. |
| Claim(Int32) | (Inherited from RFIDScannerBasic) |
| ClearInput() | (Inherited from RFIDScannerBasic) |
| ClearInputImpl() | (Inherited from RFIDScannerBasic) |
| ClearInputProperties() |
Clears all data properties and sets them to their default values. |
| ClearOutput() | (Inherited from RFIDScannerBasic) |
| ClearOutputImpl() | (Inherited from RFIDScannerBasic) |
| Close() | (Inherited from RFIDScannerBasic) |
| 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 RFIDScannerBasic) |
| CreateStatistic(String, Boolean) | (Inherited from RFIDScannerBasic) |
| 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) |
| DisableTag(Byte[], Int32, Byte[]) |
Permanently disables the specific tag matching the tagID parameter. (Inherited from RFIDScanner) |
| Dispose() | (Inherited from RFIDScannerBasic) |
| Dispose(Boolean) | (Inherited from RFIDScannerBasic) |
| FirstTag() |
Resets the service’s counter to the first tag in the tag list, and copies that tag’s information into the corresponding properties. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from RFIDScannerBasic) |
| IncrementStatistic(String, Int32) | (Inherited from RFIDScannerBasic) |
| IncrementStatistic(String) | (Inherited from RFIDScannerBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| LockTag(Byte[], Int32, Byte[]) |
Turns the tag into a read-only mode. (Inherited from RFIDScanner) |
| NextTag() |
Moves the service’s counter to the next tag in the tag list, and copies that tag’s information into the corresponding properties. |
| 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 RFIDScannerBasic) |
| PreFireEvent(DirectIOEventArgs) | (Inherited from RFIDScannerBasic) |
| PreFireEvent(OutputCompleteEventArgs) | (Inherited from RFIDScannerBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from RFIDScannerBasic) |
| PreviousTag() |
Moves the service’s counter to the previous tag in the tag list, and copies that tag’s information into the corresponding properties. |
| QueueEvent(DataEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEvent(DeviceErrorEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEvent(OutputCompleteEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEventAndWait(DeviceErrorEventArgs) | (Inherited from RFIDScannerBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from RFIDScannerBasic) |
| ReadRFIDTags(RFIDReadOptions, Int32, Int32, Byte[]) |
Performs a poll of all tags within range that meet the parameterized criteria. |
| ReadTags(RFIDReadOptions, Byte[], Byte[], Int32, Int32, Int32, Byte[]) |
Begins a poll of all the tags within range that meet the parameterized criteria. |
| Release() | (Inherited from RFIDScannerBasic) |
| ResetStatistic(String) | (Inherited from RFIDScannerBasic) |
| ResetStatistics() | (Inherited from RFIDScannerBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from RFIDScannerBasic) |
| ResetStatistics(String[]) | (Inherited from RFIDScannerBasic) |
| RetrieveStatistic(String) | (Inherited from RFIDScannerBasic) |
| RetrieveStatistics() | (Inherited from RFIDScannerBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from RFIDScannerBasic) |
| RetrieveStatistics(String[]) | (Inherited from RFIDScannerBasic) |
| 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 RFIDScannerBasic) |
| SetStatisticValue(String, Object) | (Inherited from RFIDScannerBasic) |
| StartReadTags(RFIDReadOptions, Byte[], Byte[], Int32, Int32, Byte[]) |
Performs a continuous polling of tags that meet the parameterized criteria. |
| StopReadTags(Byte[]) |
Stops the Continuous Read mode. |
| 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 RFIDScannerBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from RFIDScannerBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from RFIDScannerBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from RFIDScannerBasic) |
| WriteTagData(Byte[], Byte[], Int32, Int32, Byte[]) |
Overwrites the entire or part of the userData field of targeted tag. |
| WriteTagDataImpl(Byte[], Byte[], Int32, Int32, Byte[], DateTime) |
Overwrites all or partial user data contained in the tag. |
| WriteTagId(Byte[], Byte[], Int32, Byte[]) |
Overwrites the existing tag ID with a new ID. (Inherited from RFIDScanner) |
Events
| DataEvent | (Inherited from RFIDScannerBasic) |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from RFIDScannerBasic) |
| ErrorEvent | (Inherited from RFIDScannerBasic) |
| OutputCompleteEvent | (Inherited from RFIDScannerBasic) |
| StateChangedEvent | (Inherited from RFIDScannerBasic) |
| StatusUpdateEvent | (Inherited from RFIDScannerBasic) |