LockKeyboard

When launching a BlueZone session from a web page via an Object Tag, the <PARAM NAME="LockKeyboard" VALUE="Yes”> PARAM name VALUE pair can be manually added to the Object Tag in order to initially set the keyboard to state “locked.” When a session's keyboard is locked, all user keyboard input is ignored. This feature is useful when a process is automating a session after it launches, such as through a web page script, or when BlueZone sessions itself is auto-playing a script or macro. Locking the keyboard prohibits user input during session startup and automation.

However, in order for the user to be able to use BlueZone when the process is finished, you must unlock the keyboard To unlock the keyboard, an external process can call the LockKeyboard( False ) method of the BlueZone Host Automation Object as shown in the example below.

Note

If BlueZone is playing a script or macro, BlueZone auto-unlocks the keyboard when the script or macro completes. The LockKeyboard( False ) method is only needed to unlock the BlueZone keyboard when a process external to BlueZone has completed.

Parameters

LockVal

True or False

Returns

0 for success; or a non-zero error code. Refer to Error codes for a complete listing of error code descriptions.

Remarks

Setting to True locks the keyboard and setting it to False unlocks the keyboard.

Example

Set Host = CreateObject( "BZWhll.WhllObj" )
Host.Connect "A"
Host.LockKeyboard( False )
Host.MsgBox( "The keyboard has been unlocked! BlueZone is ready for your input.", 0 )