Share via

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

  • Article

2/27/2008

Gets or sets the Boolean value that indicates whether the device delivers a StatusUpdateEvent when it becomes idle.

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, a StatusUpdateEvent is queued whenever the device state is idle. This property is automatically reset to false as soon as the queued StatusUpdateEvent is delivered.

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

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

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

ElectronicJournal Class
ElectronicJournal Members
Microsoft.PointOfService Namespace
ElectronicJournal.ClearOutput Method
ErrorEvent
ElectronicJournal.FlagWhenIdle Property