Share via


PosCommon Members (POS for .NET v1.12 SDK Documentation)

2/27/2008

Defines the programmatic interface for constants, properties, methods, and events common to all UPOS devices.

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

Protected Constructors

  Name Description
PosCommon Creates an instance of the PosCommon class.

Top

Public Fields

  Name Description
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).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.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif ExtendedErrorStatistics Indicates a specified statistic could not be reset or updated.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif ExtendedErrorStatisticsDependency  
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticCommunicationErrorCount Holds the programmatic name of the Communication Error Count common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticDeviceCategory Holds the programmatic name of the Device Category common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticFirmwareRevision Holds the programmatic name of the Firmware Revision common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticHoursPoweredCount Holds the programmatic name of the Hours Powered On common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticInstallationDate Holds the programmatic name of the Installation Date common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticInterface Holds the programmatic name of the Interface common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticManufactureDate Holds the programmatic name of the Manufacture Date common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticManufacturerName Holds the programmatic name of the Manufacturer Name common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticMechanicalRevision Holds the programmatic name of the Mechanical Revision common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticModelName Holds the programmatic name of the Model Name common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticSerialNumber Holds the programmatic name of the Serial Number common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatisticUnifiedPOSVersion Holds the programmatic name of the Unified POS Version common statistic.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusPowerOff Indicates that the device’s power is turned off or it is detached from the terminal.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusPowerOffline Indicates that the device is powered on but is either not ready or unable to respond to requests.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusPowerOffOffline Indicates that either the device’s power is off or it is offline.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusPowerOnline Indicates that the device’s power is turned on and it is ready for use.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareComplete Indicates the update firmware process has completed successfully.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).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. 
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceNeedsFirmware Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceOk Indicates the update firmware process failed. However, the device is still operational.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnknown Indicates the update firmware process failed. The device is in an indeterminate state.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnrecoverable Indicates the update firmware process failed. The device is either unusable or unrecoverable through software.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareProgress Indicates the update firmware process has completed 1 to 100 percent successfully.
ms884824.pubfield(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).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.

Top

Public Properties

(see also Protected Properties )

  Name Description
ms884824.pubproperty(en-US,WinEmbedded.11).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.
ms884824.pubproperty(en-US,WinEmbedded.11).gif CapPowerReporting Gets the power reporting capabilities of the device.
ms884824.pubproperty(en-US,WinEmbedded.11).gif CapStatisticsReporting Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage.
ms884824.pubproperty(en-US,WinEmbedded.11).gif CapUpdateFirmware Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method.
ms884824.pubproperty(en-US,WinEmbedded.11).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.
ms884824.pubproperty(en-US,WinEmbedded.11).gif CheckHealthText Gets a string that indicates the health of the device.
ms884824.pubproperty(en-US,WinEmbedded.11).gif Claimed Gets a Boolean value that indicates whether the device is claimed for exclusive access.
ms884824.pubproperty(en-US,WinEmbedded.11).gif Compatibility  Gets the compatibility level of a device. (inherited from PosDevice)
ms884824.pubproperty(en-US,WinEmbedded.11).gif DeviceDescription Gets a string identifying the device and the company that manufactured it.
ms884824.pubproperty(en-US,WinEmbedded.11).gif DeviceEnabled Gets or sets a Boolean value that indicates whether the device has been placed in an operational state.
ms884824.pubproperty(en-US,WinEmbedded.11).gif DeviceName Gets a short string identifying the device and any pertinent information about it.
ms884824.pubproperty(en-US,WinEmbedded.11).gif FreezeEvents Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events.
ms884824.pubproperty(en-US,WinEmbedded.11).gif PowerNotify Gets or sets the type of power notification selection made by the application.
ms884824.pubproperty(en-US,WinEmbedded.11).gif PowerState Gets the current power condition.
ms884824.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectDescription Gets a string identifying the Service Object that supports the device and the company that produced it.
ms884824.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectVersion Gets the Service Object version number.
ms884824.pubproperty(en-US,WinEmbedded.11).gif State Gets the current state of the device.
ms884824.pubproperty(en-US,WinEmbedded.11).gif SynchronizingObject Gets or sets the object that is used to marshal the event handler calls issued because of a POS event.

Top

Protected Properties

  Name Description
ms884824.protproperty(en-US,WinEmbedded.11).gif DeviceInstanceId  
ms884824.protproperty(en-US,WinEmbedded.11).gif DevicePath Gets or sets the hardware path of a device.
ms884824.protproperty(en-US,WinEmbedded.11).gif HardwareId  
ms884824.protproperty(en-US,WinEmbedded.11).gif IsExclusiveUseDevice Gets a Boolean value that indicates whether the device is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

  Name Description
ms884824.pubmethod(en-US,WinEmbedded.11).gif CheckHealth Tests the state of a device.
ms884824.pubmethod(en-US,WinEmbedded.11).gif Claim Requests exclusive access to the device.
ms884824.pubmethod(en-US,WinEmbedded.11).gif Close Releases the device and its resources.
ms884824.pubmethod(en-US,WinEmbedded.11).gif CompareFirmwareVersion 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.
ms884824.pubmethod(en-US,WinEmbedded.11).gif DirectIO Used to communicate directly with the Service Object.
ms884824.pubmethod(en-US,WinEmbedded.11).gif Equals  Overloaded. (inherited from Object )
ms884824.pubmethod(en-US,WinEmbedded.11).gif GetHashCode  (inherited from Object )
ms884824.pubmethod(en-US,WinEmbedded.11).gif GetType  (inherited from Object )
ms884824.pubmethod(en-US,WinEmbedded.11).gif Open Opens a device for later input/output processing.
ms884824.pubmethod(en-US,WinEmbedded.11).gifms884824.static(en-US,WinEmbedded.11).gif ReferenceEquals  (inherited from Object )
ms884824.pubmethod(en-US,WinEmbedded.11).gif Release Releases exclusive access to the device.
ms884824.pubmethod(en-US,WinEmbedded.11).gif ResetStatistic Resets the specified statistic to 0 (zero).
ms884824.pubmethod(en-US,WinEmbedded.11).gif ResetStatistics Overloaded.  
ms884824.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistic Retrieves the specified device statistic.
ms884824.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistics Overloaded.  
ms884824.pubmethod(en-US,WinEmbedded.11).gif ToString  (inherited from Object )
ms884824.pubmethod(en-US,WinEmbedded.11).gif UpdateFirmware 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.
ms884824.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistic Updates the value of a specified device statistic.
ms884824.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistics Overloaded.  

Top

Protected Methods

  Name Description
ms884824.protmethod(en-US,WinEmbedded.11).gif DeleteConfigurationProperty Deletes the specified property from the XML configuration file.
ms884824.protmethod(en-US,WinEmbedded.11).gif Finalize  (inherited from Object )
ms884824.protmethod(en-US,WinEmbedded.11).gif GetConfigurationProperty Used by the Service Object to retrieve the specified property from the XML configuration file.
ms884824.protmethod(en-US,WinEmbedded.11).gif Invoke Used by the Service Objects to raise an event.
ms884824.protmethod(en-US,WinEmbedded.11).gif MemberwiseClone  (inherited from Object )
ms884824.protmethod(en-US,WinEmbedded.11).gif SetConfigurationProperty Sets a property value (or create a new property) in the XML configuration file.

Top

Public Events

(see also Protected Events )

  Name Description
ms884824.pubevent(en-US,WinEmbedded.11).gif DirectIOEvent Raised by the Service Object to communicate information directly to the application.
ms884824.pubevent(en-US,WinEmbedded.11).gif StatusUpdateEvent Raised by the Service Object to alert the application of a device status change.

Top

Protected Events

  Name Description
ms884824.protevent(en-US,WinEmbedded.11).gif DeviceAddedEvent  
ms884824.protevent(en-US,WinEmbedded.11).gif DeviceRemovedEvent  

Top

See Also

Reference

PosCommon Class
Microsoft.PointOfService Namespace