PosPower Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Defines the programmatic interface for a UPOS power system device.
The following tables list the members exposed by the PosPower type.
Protected Constructors
| Name | Description | |
|---|---|---|
| PosPower | Creates an instance of the PosPower class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "ms884865.pubfield(en-US,WinEmbedded.11).gif") .gif "ms884865.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. (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) |
|
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) |
|
StatusBatteryCapacityRemaining | Indicates the BatteryCapacityRemaining property has been updated. |
|
StatusBatteryCritical | Indicates the remaining battery capacity is at or below the critically low battery threshold and the system is operating from the battery. |
|
StatusBatteryLow | Indicates the remaining battery capacity is at or below the low battery threshold and the system is operating from the battery. |
|
StatusFanRunning | Indicates the fan is running. |
|
StatusFanStopped | Indicates the fan has stopped. |
|
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) |
|
StatusPowerSource | Indicates the PowerSource property has been updated. |
|
StatusRestart | Indicates the system will restart immediately. |
|
StatusShutDown | Indicates the device has shut down. |
|
StatusStandby | Indicates the system is requesting a transition to the Standby state. |
|
StatusSuspend | Indicates the system is requesting a transition to the Suspend state. |
|
StatusTemperatureHigh | Indicates the device is running at a high temperature. |
|
StatusTemperatureOK | Indicates the device's temperature is within acceptable range. |
|
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) |
|
StatusUpsCritical | Indicates the UPS battery is in a critical state. |
|
StatusUpsFull | Indicates the UPS battery is almost full charge. |
|
StatusUpsLow | Indicates the UPS battery is almost depleted of charge. |
|
StatusUpsWarning | Indicates the UPS battery is near 50 percent charge. |
|
StatusUserStandby | Indicates the system is requesting a transition to the Standby state because of user input. |
|
StatusUserSuspend | Indicates the system is requesting a transition to the Suspend state because of user input. |
|
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 | |
|---|---|---|
.gif "ms884865.pubproperty(en-US,WinEmbedded.11).gif") |
BatteryCapacityRemaining | Gets a value between 0 and 100 that represents the percentage of remaining battery capacity. |
|
BatteryCriticallyLowThreshold | Gets or sets the threshold percentage at which the service object generates a StatusUpdateEvent event of StatusBatteryCritical. |
|
BatteryLowThreshold | Gets or sets the threshold percentage at which the service object generates a StatusUpdateEvent event of StatusBatteryLow. |
|
CapBatteryCapacityRemaining | Gets a Boolean value that indicates whether the device can provide information about the remaining capacity of the battery. |
|
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) |
|
CapFanAlarm | Gets a Boolean value that indicates whether the device can detect the CPU fan is stopped. |
|
CapHeatAlarm | Gets a Boolean value that indicates whether the device can detect if the CPU is running at a high temperature. |
|
CapPowerReporting | Gets the power reporting capabilities of the device. (inherited from PosCommon) |
|
CapQuickCharge | Gets a Boolean value that indicates whether power management allows charging the battery with a quick method. |
|
CapRestartPos | Gets a Boolean value that indicates whether the device can explicitly restart the POS system. |
|
CapShutdownPos | Gets a Boolean value that indicates whether the device can explicitly shut down the POS system. |
|
CapStandbyPos | Gets a Boolean value that indicates whether the device can request that the POS system enter a Standby state. |
|
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon) |
|
CapSuspendPos | Gets a Boolean value that indicates whether the device can request that the POS system enter a Suspend state. |
|
CapUpdateFirmware | Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon) |
|
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) |
|
CapUpsChargeState | Gets one or more UPS charge states. |
|
CapVariableBatteryCriticallyLowThreshold | Gets a Boolean value that indicates whether the device supports a variable threshold for critically low battery capacity reporting that can be set by the POS application. |
|
CapVariableBatteryLowThreshold | Gets a Boolean value that indicates whether the device supports a variable threshold for low battery capacity reporting that can be set by the POS application. |
|
CheckHealthText | Gets a string that indicates the health of the device. (inherited from PosCommon) |
|
Claimed | Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon) |
|
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) |
|
DeviceDescription | Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon) |
|
DeviceEnabled | Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon) |
|
EnforcedShutdownDelayTime | Gets or sets an integer value for a built-in mechanism to shut down the POS terminal. |
|
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon) |
|
PowerFailDelayTime | Gets the time in milliseconds for power failure intervals. |
|
PowerNotify | Gets or sets the type of power notification selection made by the application. (inherited from PosCommon) |
|
PowerSource | Gets the current power source. |
|
PowerState | Gets the current power condition. (inherited from PosCommon) |
|
QuickChargeMode | Gets a Boolean value that indicates whether the battery is being recharged in a quick charge mode. |
|
QuickChargeTime | Gets the remaining time for loading the battery. |
|
ServiceObjectDescription | Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon) |
|
ServiceObjectVersion | Gets the Service Object version number. (inherited from PosCommon) |
|
State | Gets the current state of the device. (inherited from PosCommon) |
|
SynchronizingObject | Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon) |
|
UpsChargeState | Gets the UPS charge state. |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms884865.protproperty(en-US,WinEmbedded.11).gif") |
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicates whether the PosPower device is exclusive-use. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms884865.pubmethod(en-US,WinEmbedded.11).gif") |
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PosCommon ) |
|
Close | Releases the device and its resources. (inherited from PosCommon) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
DirectIO | (inherited from PosCommon ) |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
|
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
RestartPos | Restarts the POS system independent of the power state. |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
ShutdownPos | Shuts down the POS system independent of the power state. |
|
StandbyPos | Requests that the POS system be put in the Standby state or responds to a request to put the system in the Standby state. |
|
SuspendPos | Requests that the POS system be put in the Suspend state or responds to a request to put the system in the Suspend state. |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms884865.protmethod(en-US,WinEmbedded.11).gif") |
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "ms884865.pubevent(en-US,WinEmbedded.11).gif") |
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon) |
|
StatusUpdateEvent | Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "ms884865.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top