PosPowerBasic 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.
public abstract class PosPowerBasic : Microsoft.PointOfService.PosPower, IDisposabletype PosPowerBasic = class
inherit PosPower
interface IDisposablePublic MustInherit Class PosPowerBasic
Inherits PosPower
Implements IDisposable- Inheritance
- Implements
Constructors
| PosPowerBasic() |
Fields
| 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. (Inherited from PosPower) |
| StatusBatteryCritical |
Indicates the remaining battery capacity is at or below the critically low battery threshold and the system is operating from the battery. (Inherited from PosPower) |
| StatusBatteryLow |
Indicates the remaining battery capacity is at or below the low battery threshold and the system is operating from the battery. (Inherited from PosPower) |
| StatusFanRunning |
Indicates the fan is running. (Inherited from PosPower) |
| StatusFanStopped |
Indicates the fan has stopped. (Inherited from PosPower) |
| 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. (Inherited from PosPower) |
| StatusRestart |
Indicates the system will restart immediately. (Inherited from PosPower) |
| StatusShutDown |
Indicates the device has shut down. (Inherited from PosPower) |
| StatusStandby |
Indicates the system is requesting a transition to the Standby state. (Inherited from PosPower) |
| StatusSuspend |
Indicates the system is requesting a transition to the Suspend state. (Inherited from PosPower) |
| StatusTemperatureHigh |
Indicates the device is running at a high temperature. (Inherited from PosPower) |
| StatusTemperatureOK |
Indicates the device's temperature is within acceptable range. (Inherited from PosPower) |
| 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. (Inherited from PosPower) |
| StatusUpsFull |
Indicates the UPS battery is almost full charge. (Inherited from PosPower) |
| StatusUpsLow |
Indicates the UPS battery is almost depleted of charge. (Inherited from PosPower) |
| StatusUpsWarning |
Indicates the UPS battery is near 50 percent charge. (Inherited from PosPower) |
| StatusUserStandby |
Indicates the system is requesting a transition to the Standby state because of user input. (Inherited from PosPower) |
| StatusUserSuspend |
Indicates the system is requesting a transition to the Suspend state because of user input. (Inherited from PosPower) |
| 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
| BatteryCapacityRemaining |
Gets a value between 0 and 100 that represents the percentage of remaining battery capacity. (Inherited from PosPower) |
| BatteryCriticallyLowThreshold | (Inherited from PosPower) |
| BatteryLowThreshold | (Inherited from PosPower) |
| CapBatteryCapacityRemaining | (Inherited from PosPower) |
| CapCompareFirmwareVersion | |
| CapFanAlarm |
Gets a Boolean value that indicates whether the device can detect the CPU fan is stopped. (Inherited from PosPower) |
| CapHeatAlarm |
Gets a Boolean value that indicates whether the device can detect if the CPU is running at a high temperature. (Inherited from PosPower) |
| CapPowerReporting | |
| CapQuickCharge |
Gets a Boolean value that indicates whether power management allows charging the battery with a quick method. (Inherited from PosPower) |
| CapRestartPos | (Inherited from PosPower) |
| CapShutdownPos |
Gets a Boolean value that indicates whether the device can explicitly shut down the POS system. (Inherited from PosPower) |
| CapStandbyPos | (Inherited from PosPower) |
| CapStatisticsReporting | |
| CapSuspendPos | (Inherited from PosPower) |
| CapUpdateFirmware | |
| CapUpdateStatistics | |
| CapUpsChargeState |
Gets one or more UPS charge states. (Inherited from PosPower) |
| CapVariableBatteryCriticallyLowThreshold | (Inherited from PosPower) |
| CapVariableBatteryLowThreshold | (Inherited from PosPower) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | |
| CommonProperties | |
| Compatibility | (Inherited from PosDevice) |
| DeviceDescription | |
| DeviceEnabled | |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| EnforcedShutdownDelayTime |
Gets or sets an integer value for a built-in mechanism to shut down the POS terminal. (Inherited from PosPower) |
| ExternallyClaimed | |
| FreezeEvents | |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice | (Inherited from PosPower) |
| PowerFailDelayTime |
Gets the time in milliseconds for power failure intervals. (Inherited from PosPower) |
| PowerNotify | |
| PowerSource | (Inherited from PosPower) |
| PowerState | |
| QuickChargeMode |
Gets a Boolean value that indicates whether the battery is being recharged in a quick charge mode. (Inherited from PosPower) |
| QuickChargeTime |
Gets the remaining time for loading the battery. (Inherited from PosPower) |
| ServiceObjectDescription | |
| ServiceObjectVersion | |
| State | |
| 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. (Inherited from PosPower) |
Methods
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | |
| Close() | |
| 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) | |
| CreateStatistic(String, Boolean) | |
| 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) |
| Dispose() | |
| Dispose(Boolean) | |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | |
| IncrementStatistic(String, Int32) | |
| IncrementStatistic(String) | |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() | |
| PreFireEvent(DirectIOEventArgs) | |
| PreFireEvent(StatusUpdateEventArgs) | |
| QueueEvent(DirectIOEventArgs) | |
| QueueEvent(StatusUpdateEventArgs) | |
| QueueEventAndWait(DirectIOEventArgs) | |
| Release() | |
| ResetStatistic(String) | |
| ResetStatistics() | |
| ResetStatistics(StatisticCategories) | |
| ResetStatistics(String[]) | |
| RestartPos() |
Restarts the POS system independent of the power state. (Inherited from PosPower) |
| RetrieveStatistic(String) | |
| RetrieveStatistics() | |
| RetrieveStatistics(StatisticCategories) | |
| RetrieveStatistics(String[]) | |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | |
| SetStatisticValue(String, Object) | |
| ShutdownPos() |
Shuts down the POS system independent of the power state. (Inherited from PosPower) |
| StandbyPos(SystemStateChangeReason) |
Requests that the POS system be put in the Standby state or responds to a request to put the system in the Standby state. (Inherited from PosPower) |
| SuspendPos(SystemStateChangeReason) |
Requests that the POS system be put in the Suspend state or responds to a request to put the system in the Suspend state. (Inherited from PosPower) |
| 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) | |
| UpdateStatistics(Statistic[]) | |
| UpdateStatistics(StatisticCategories, Object) | |
| VerifyState(Boolean, Boolean) | |
Events
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | |
| StateChangedEvent | |
| StatusUpdateEvent | |