ErrorCode Enumeration (POS for .NET v1.12 SDK Documentation)
2/27/2008
Enumerates the valid types of errors for an error event.
Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)
Syntax
'Declaration
Public Enumeration ErrorCode
public enum ErrorCode
public enum class ErrorCode
public enum ErrorCode
public enum ErrorCode
Members
| Member name | Description |
|---|---|
| Busy | The current state does not allow this request. For example: if asynchronous output is in progress, certain methods may not be allowed. |
| Claimed | The device is opened but not claimed. Another application has the device claimed, so it cannot be claimed at this time. |
| Closed | The device must be opened. |
| Deprecated | The method has been deprecated and is no longer available. |
| Disabled | The device is opened and claimed (if this is an exclusive use device), but not enabled. |
| Exists | The file name (or other specified value) already exists. |
| Extended | A device category-specific error condition occurred. The error condition code is held in the exception's ErrorCodeExtended property. |
| Failure | The device cannot perform the requested procedure, even though the physical device is connected to the system, powered on, and on-line. |
| Illegal | An attempt was made to perform an illegal or unsupported operation with the device, or an invalid parameter value was used. |
| NoExist | The file name (or other specified value) does not exist. |
| NoHardware | The physical device is not connected to the system or is not powered on. |
| NoService | The control cannot communicate with the service object, normally because of a setup or configuration error. |
| NotClaimed | The device is opened but not claimed. No other application has the device claimed, so it can and must be claimed. |
| Offline | The physical device is off-line. |
| Success | No error occurred. |
| Timeout | The service object timed out waiting for a response from the physical device, or the control timed out waiting for a response from the service object. |
Remarks
The ErrorCode enumeration represents the full set of standard UPOS error codes. A mapping between the UPOS error codes and their POS for .NET equivalents is provided in the Exception Classes topic in the POS for .NET Reference Guide.
It is typically used by the PosControlException class to return these UPOS-defined error codes to the POS for .NET application for handling.
ErrorCode is also used by the DeviceErrorEventArgs constructor and ErrorCode property.
The special value Extended allows the application to receive device-specific extended error codes in the exception's ErrorCodeExtended property. See the device documentation to find what extended error codes may be used in conjunction with this value.