PosCommon.FreezeEvents Property (POS for .NET v1.12 SDK Documentation)

2/27/2008

Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events.

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

Syntax

'Declaration
Public MustOverride Property FreezeEvents As Boolean

public abstract bool FreezeEvents { get; set; }

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

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

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

public abstract function get FreezeEvents () : boolean

public abstract function set FreezeEvents (value : boolean)

Remarks

When set to true, the application has requested that the Service Object not deliver events. Events will be queued by the Service Object but not delivered until the application changes the FreezeEvents property to false. Exclusive-use devices must be opened and claimed before this property can be accessed. Shared devices must be opened before this property can be accessed.

When set to false, the application allows events to be delivered. If some events have been held while events were frozen and all other conditions are correct for delivering the events, changing the FreezeEvents property to false allows these events to be delivered.

An application can choose to freeze events for a specific sequence of code where interruption by an event is not desirable.

The FreezeEvents property is initialized to false. State verification occurs in the basic and base classes for each device.

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

PosCommon Class
PosCommon Members
Microsoft.PointOfService Namespace