Share via

FiscalPrinter.FlagWhenIdle Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Gets or sets a Boolean value that indicates whether the service object raises a StatusUpdateEvent event if it is in the Idle state.

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

Syntax

'Declaration
Public MustOverride Property FlagWhenIdle As Boolean

public abstract bool FlagWhenIdle { get; set; }

public:
virtual property bool FlagWhenIdle {
    bool get () abstract;
    void set (bool value) abstract;
}

/** @property */
public abstract boolean get_FlagWhenIdle ()

/** @property */
public abstract void set_FlagWhenIdle (boolean value)

public abstract function get FlagWhenIdle () : boolean

public abstract function set FlagWhenIdle (value : boolean)

Remarks

If true, the service object raises a StatusUpdateEvent if it is in the Idle state. If false, this event is not raised.

FlagWhenIdle is automatically reset to false when the status event is delivered.

The main use of idle status event controlled by FlagWhenIdle is to give the application control when all outstanding asynchronous outputs have been processed. The event is raised if the outputs were completed successfully or if they were cleared by the ClearOutput method or by an ErrorEvent handler.

If the state is already set to Idle when the FlagWhenIdle property is set to true, a StatusUpdateEvent is raised immediately. The application can therefore depend on the event, without a race condition between the starting of its last asynchronous output and the setting of this flag.

FlagWhenIdle is set and kept current by the service object while the device is enabled.

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

FiscalPrinter Class
FiscalPrinter Members
Microsoft.PointOfService Namespace