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

Top

Public Fields

	Name	Description
	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.
	ExtendedErrorStatistics	Indicates a specified statistic could not be reset or updated.
	ExtendedErrorStatisticsDependency
	StatisticCommunicationErrorCount	Holds the programmatic name of the Communication Error Count common statistic.
	StatisticDeviceCategory	Holds the programmatic name of the Device Category common statistic.
	StatisticFirmwareRevision	Holds the programmatic name of the Firmware Revision common statistic.
	StatisticHoursPoweredCount	Holds the programmatic name of the Hours Powered On common statistic.
	StatisticInstallationDate	Holds the programmatic name of the Installation Date common statistic.
	StatisticInterface	Holds the programmatic name of the Interface common statistic.
	StatisticManufactureDate	Holds the programmatic name of the Manufacture Date common statistic.
	StatisticManufacturerName	Holds the programmatic name of the Manufacturer Name common statistic.
	StatisticMechanicalRevision	Holds the programmatic name of the Mechanical Revision common statistic.
	StatisticModelName	Holds the programmatic name of the Model Name common statistic.
	StatisticSerialNumber	Holds the programmatic name of the Serial Number common statistic.
	StatisticUnifiedPOSVersion	Holds the programmatic name of the Unified POS Version common statistic.
	StatusPowerOff	Indicates that the device’s power is turned off or it is detached from the terminal.
	StatusPowerOffline	Indicates that the device is powered on but is either not ready or unable to respond to requests.
	StatusPowerOffOffline	Indicates that either the device’s power is off or it is offline.
	StatusPowerOnline	Indicates that the device’s power is turned on and it is ready for use.
	StatusUpdateFirmwareComplete	Indicates the update firmware process has completed successfully.
	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.
	StatusUpdateFirmwareFailedDeviceNeedsFirmware	Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful.
	StatusUpdateFirmwareFailedDeviceOk	Indicates the update firmware process failed. However, the device is still operational.
	StatusUpdateFirmwareFailedDeviceUnknown	Indicates the update firmware process failed. The device is in an indeterminate state.
	StatusUpdateFirmwareFailedDeviceUnrecoverable	Indicates the update firmware process failed. The device is either unusable or unrecoverable through software.
	StatusUpdateFirmwareProgress	Indicates the update firmware process has completed 1 to 100 percent successfully.
	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
	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.
	CapPowerReporting	Gets the power reporting capabilities of the device.
	CapStatisticsReporting	Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage.
	CapUpdateFirmware	Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method.
	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.
	CheckHealthText	Gets a string that indicates the health of the device.
	Claimed	Gets a Boolean value that indicates whether the device is claimed for exclusive access.
	Compatibility	Gets the compatibility level of a device. (inherited from PosDevice)
	DeviceDescription	Gets a string identifying the device and the company that manufactured it.
	DeviceEnabled	Gets or sets a Boolean value that indicates whether the device has been placed in an operational state.
	DeviceName	Gets a short string identifying the device and any pertinent information about it.
	FreezeEvents	Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events.
	PowerNotify	Gets or sets the type of power notification selection made by the application.
	PowerState	Gets the current power condition.
	ServiceObjectDescription	Gets a string identifying the Service Object that supports the device and the company that produced it.
	ServiceObjectVersion	Gets the Service Object version number.
	State	Gets the current state of the device.
	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
	DeviceInstanceId
	DevicePath	Gets or sets the hardware path of a device.
	HardwareId
	IsExclusiveUseDevice	Gets a Boolean value that indicates whether the device is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

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

Top

Protected Methods

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

Top

Public Events

(see also Protected Events )

	Name	Description
	DirectIOEvent	Raised by the Service Object to communicate information directly to the application.
	StatusUpdateEvent	Raised by the Service Object to alert the application of a device status change.

Top

Protected Events

	Name	Description
	DeviceAddedEvent
	DeviceRemovedEvent

Top

See Also

Reference

PosCommon Class
Microsoft.PointOfService Namespace