PrintResults Class (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

The PrintResults helper class simplifies the return of status from service object-implemented base class methods and is used by the PosPrinterBase class to maintain and update printer statistics.

Namespace: Microsoft.PointOfService.BaseServiceObjects
Assembly: Microsoft.PointOfService.ControlBase (in microsoft.pointofservice.controlbase.dll)

Syntax

'Declaration
Public Class PrintResults

public class PrintResults

public ref class PrintResults

public class PrintResults

public class PrintResults

Remarks

PrintResults is a helper class created by POS for .NET to simplify the return of status from service object-implemented base class methods. PrintResults is also used by the PosPrinterBase class to maintain and update printer statistics. A number of service object-implemented printer methods (the *Impl methods) return an instance of PrintResults. For these methods, service objects must report errors by updating the error-related properties of the PrintResults class. (For methods that do not return an instance of the PrintResults class, the service object should throw exceptions.)

Any statistics that have been updated in PrintResults will be updated by the base class upon return from the *Impl method. Returning any non-zero value for ErrorCode will result in a PosControlException exception being thrown if the device is in synchronous mode, or an ErrorEvent event being queued if the device is in asynchronous mode. The ErrorLevel, ErrorStation, and ErrorString properties will also be updated when the ErrorEvent event is delivered to the application.

Inheritance Hierarchy

System.Object
  Microsoft.PointOfService.BaseServiceObjects.PrintResults

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PrintResults Members
Microsoft.PointOfService.BaseServiceObjects Namespace