Keylock.WaitForKeylockChange Method

2/27/2008

Used by the application to wait for a specified keylock position to be set.

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

Syntax

'Declaration
Public MustOverride Sub WaitForKeylockChange ( _
    keyPosition As Integer, _
    timeout As Integer _
)

public abstract void WaitForKeylockChange (
    int keyPosition,
    int timeout
)

public:
virtual void WaitForKeylockChange (
    int keyPosition, 
    int timeout
) abstract

public abstract void WaitForKeylockChange (
    int keyPosition, 
    int timeout
)

public abstract function WaitForKeylockChange (
    keyPosition : int, 
    timeout : int
)

keyPosition
Requested keylock position.keyPosition can contain one of the following values:

Value	Meaning
PositionAny	Wait for any keylock position change.
PositionLocked	Wait for keylock position to be set to the “locked” position.
PositionNormal	Wait for keylock position to be set to the “normal” position.
PositionElectronic	Wait for keylock position to be set to the “electronic” position.
PositionSupervisor	Wait for keylock position to be set to the “supervisor” position.
Other Values	Wait for keylock position to be set to one of the auxiliary positions. This value may range from four (4) up to the total number of keylock positions indicated by the PositionCount property.

timeout
Maximum number of milliseconds to wait for the keylock before returning control back to the application.If zero, WaitForKeylockChange returns the appropriate status immediately.If WaitForever, WaitForKeylockChange waits as long as needed until the requested key position is satisfied or an error occurs.

If the keylock position specified by KeyPosition is the same as the current keylock position, the method returns immediately.

If CapKeylockType is Electronic, only PositionAny is allowed as value of the KeyPosition parameter.

WaitForKeylockChange may cause a PosControlException to be thrown with one of the following ErrorCodes:

Value	Meaning
Illegal	The specified value is not valid.
Timeout	The timeout period expired before the requested keylock positioning occurred.

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