Share via


RFIDScanner Members

2/27/2008

Defines the programmatic interface for an RFID Scanner device.

The following tables list the members exposed by the RFIDScanner type.

Protected Constructors

  Name Description
RFIDScanner Creates an instance of the RFIDScanner class.

Top

Public Fields

  Name Description
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif ExtendedErrorAntennaFailure Indicates if the RF antenna is in a state of failure.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif 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)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif ExtendedErrorStatistics  Indicates a specified statistic could not be reset or updated. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif ExtendedErrorStatisticsDependency  (inherited from PosCommon )
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticCommunicationErrorCount  Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticDeviceCategory  Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticFailedTagDisableCount Contains the count of failed tag disable attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticFailedTagLockCount Contains the count of failed tag lock attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticFailedTagWriteCount Contains the count of failed tag write attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticFirmwareRevision  Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticGoodTagDisableCount Contains the count of successful tag disable attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticGoodTagLockCount Contains the count of successful tag lock attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticGoodTagWriteCount Contains the count of successful tag write attempts.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticHoursPoweredCount  Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticInstallationDate  Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticInterface  Holds the programmatic name of the Interface common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticManufactureDate  Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticManufacturerName  Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticMechanicalRevision  Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticModelName  Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticSerialNumber  Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticTagReadCount Contains the count of read tags.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatisticUnifiedPOSVersion  Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusExcessNoise Indicates the RFIDScanner device is experiencing excess noise.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusLowMemory Indicates the RFIDScanner device is low on memory.
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusPowerOff  Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusPowerOffline  Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusPowerOffOffline  Indicates that either the device’s power is off or it is offline. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusPowerOnline  Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareComplete  Indicates the update firmware process has completed successfully. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif 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)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif 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)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceOk  Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceUnknown  Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareFailedDeviceUnrecoverable  Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif StatusUpdateFirmwareProgress  Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon)
Cc297637.pubfield(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif 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)

Top

Public Properties

(see also Protected Properties )

  Name Description
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif AutoDisable Gets or sets a Boolean value that indicates whether the device automatically disables itself when a DataEvent event is enqueued.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapCompareFirmwareVersion  Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapContinuousRead Gets a Boolean value that indicates whether the device supports continuous reading.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapDisableTag Gets a Boolean value that indicates whether the device supports disabling a tag permanently.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapLockTag Gets a Boolean value that indicates whether this reader supports locking a tag.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapMultipleProtocols Gets a value that indicates the available predefined RFID tag protocols this device supports.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapPowerReporting  Gets the power reporting capabilities of the device. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapReadTimer Gets a Boolean value that indicates whether the device supports a read timer.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapStatisticsReporting  Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapUpdateFirmware  Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapUpdateStatistics  Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CapWriteTag Gets a flag that indicates if the Tag ID and Tag UserData fields are writable.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CheckHealthText  Gets a string that indicates the health of the device. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif Claimed  Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif Compatibility  Gets the compatibility level of a device. (inherited from PosDevice)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif ContinuousReadMode Gets a Boolean value that indicates whether the device is in Continuous Read mode.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CurrentTagId Gets the TagId of the present tag.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CurrentTagProtocol Gets the protocol that this tag was read through.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif CurrentTagUserData Gets the data that is read from the physical tag.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif DataCount Gets the number of DataEvent events enqueued by the device.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif DataEventEnabled Gets or sets a Boolean value that indicates whether the application is ready to receive input from the device.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif DeviceDescription  Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif DeviceEnabled  Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif DeviceName  Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif FreezeEvents  Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif OutputId Gets the integer value that indicates the ID number of the completed asynchronous output request.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif PowerNotify  Gets or sets the type of power notification selection made by the application. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif PowerState  Gets the current power condition. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif ProtocolMask Gets or sets a bit pattern wherein each bit signifies one predefined RFID tag protocol.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif ReadTimerInterval Gets or sets the integer value that indicates the minimum time interval between tag reads in milliseconds.
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif ServiceObjectDescription  Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif ServiceObjectVersion  Gets the Service Object version number. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif State  Gets the current state of the device. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif SynchronizingObject  Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon)
Cc297637.pubproperty(en-us,WinEmbedded.1002).gif TagCount Gets the integer value that indicates the total number of tags read by the corresponding read operation.

Top

Protected Properties

  Name Description
Cc297637.protproperty(en-us,WinEmbedded.1002).gif DeviceInstanceId  (inherited from PosCommon )
Cc297637.protproperty(en-us,WinEmbedded.1002).gif DevicePath  Gets or sets the hardware path of a device. (inherited from PosCommon)
Cc297637.protproperty(en-us,WinEmbedded.1002).gif HardwareId  (inherited from PosCommon )
Cc297637.protproperty(en-us,WinEmbedded.1002).gif IsExclusiveUseDevice Overridden. Gets a Boolean value that indicates whether the RFIDScanner is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

  Name Description
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif CheckHealth  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Claim  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ClearInput Clears the data and input error events.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ClearInputProperties Clears all data properties and sets them to their default values.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ClearOutput Clears the data and output error events.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Close  Releases the device and its resources. (inherited from PosCommon)
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif CompareFirmwareVersion  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif DirectIO  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif DisableTag Permanently disables the specific tag matching the tagID parameter.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Equals  Overloaded. (inherited from Object )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif FirstTag Resets the service’s counter to the first tag in the tag list, and copies that tag’s information into the corresponding properties.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif GetHashCode  (inherited from Object )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif GetType  (inherited from Object )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif LockTag Turns the tag into a read-only mode.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif NextTag Moves the service’s counter to the next tag in the tag list, and copies that tag’s information into the corresponding properties.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Open  Opens a device for later input/output processing. (inherited from PosCommon)
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif PreviousTag Moves the service’s counter to the previous tag in the tag list, and copies that tag’s information into the corresponding properties.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ReadTags Performs a poll of all the tags within range that meet the parameterized criteria.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Cc297637.static(en-us,WinEmbedded.1002).gif ReferenceEquals  (inherited from Object )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif Release  Releases exclusive access to the device. (inherited from PosCommon)
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ResetStatistic  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ResetStatistics  Overloaded. (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif RetrieveStatistic  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif RetrieveStatistics  Overloaded. (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif StartReadTags Performs a continuous polling of tags that meet the parameterized criteria.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif StopReadTags Stops the Continuous Read mode.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif ToString  (inherited from Object )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif UpdateFirmware  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif UpdateStatistic  (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif UpdateStatistics  Overloaded. (inherited from PosCommon )
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif WriteTagData Overwrites the entire or part of the UserData field of targeted tag.
Cc297637.pubmethod(en-us,WinEmbedded.1002).gif WriteTagId Overwrites the existing tag ID with a new ID.

Top

Protected Methods

  Name Description
Cc297637.protmethod(en-us,WinEmbedded.1002).gif DeleteConfigurationProperty  (inherited from PosCommon )
Cc297637.protmethod(en-us,WinEmbedded.1002).gif Finalize  (inherited from Object )
Cc297637.protmethod(en-us,WinEmbedded.1002).gif GetConfigurationProperty  (inherited from PosCommon )
Cc297637.protmethod(en-us,WinEmbedded.1002).gif Invoke  (inherited from PosCommon )
Cc297637.protmethod(en-us,WinEmbedded.1002).gif MemberwiseClone  (inherited from Object )
Cc297637.protmethod(en-us,WinEmbedded.1002).gif SetConfigurationProperty  (inherited from PosCommon )

Top

Public Events

(see also Protected Events )

  Name Description
Cc297637.pubevent(en-us,WinEmbedded.1002).gif DataEvent Notifies the application that input data from the RFID Scanner is available.
Cc297637.pubevent(en-us,WinEmbedded.1002).gif DirectIOEvent  Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon)
Cc297637.pubevent(en-us,WinEmbedded.1002).gif ErrorEvent Notifies the application that an RFID Scanner device error has been detected and a suitable response by the application is necessary to process the error condition.
Cc297637.pubevent(en-us,WinEmbedded.1002).gif OutputCompleteEvent Notifies the application that the queued output request associated with the OutputId attribute has completed successfully.
Cc297637.pubevent(en-us,WinEmbedded.1002).gif StatusUpdateEvent  Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon)

Top

Protected Events

  Name Description
Cc297637.protevent(en-us,WinEmbedded.1002).gif DeviceAddedEvent  (inherited from PosCommon )
Cc297637.protevent(en-us,WinEmbedded.1002).gif DeviceRemovedEvent  (inherited from PosCommon )

Top

See Also

Reference

RFIDScanner Class
Microsoft.PointOfService Namespace