Share via


Keylock.WaitForKeylockChange(Int32, Int32) Method

Definition

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

public abstract void WaitForKeylockChange (int keyPosition, int timeout);
abstract member WaitForKeylockChange : int * int -> unit
Public MustOverride Sub WaitForKeylockChange (keyPosition As Integer, timeout As Integer)

Parameters

keyPosition
Int32

Requested keylock position.keyPosition can contain one of the following values:ValueMeaningPositionAnyWait for any keylock position change.PositionLockedWait for keylock position to be set to the “locked” position.PositionNormalWait for keylock position to be set to the “normal” position.PositionElectronicWait for keylock position to be set to the “electronic” position.PositionSupervisorWait for keylock position to be set to the “supervisor” position.Other ValuesWait 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
Int32

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

Applies to