Function Reference

_IsPressed

Check if key has been pressed

#include <Misc.au3>
_IsPressed ( [$vKey = Default [, $vDLL = Default [, $bCheckModifierKey = False]]] )

Parameters

Return Value

Remarks

If calling this function repeatedly, you should open 'user32.dll' and pass the handle.
Make sure to close the handle at end of script using DllClose().
If you use $vDLL = Default and you don't terminate the AutoIt script and yous stop using _IsPressed(...)
then call _IsPressed() to close the internal used handle.

If $vKey is a string or a $VK_* as defined in "WinAPIvkeysConstants.au3" then
_IsPressed() will return 1 until the key is pressed.
Even brief key presses can result in multiple returns within a loop.
If the code called does not include a blocking function (such as MsgBox) and the user does not require multiple returns,
the script should wait until _IsPressed() returns 0 before continuing (See example 1).

If $vKey is an array then the function returns when the key is pressed,
the return value is 1 if the $vKey[0] is pressed, 2 if the $vKey[1] is pressed, ... (See example 2).

When $bCheckModifierKey is Not True, then the combinaison of a "modifier key" + key will return 0,
and the @extended is set when the modifier key pressed to: 1 = SHIFT, 2 = CTRL, 3 = ALT, 4 = WIN, 5 = right WIN (See example 2).

If $bCheckModifierKey = True then the return occur when the "modifier key" is released.
If $bCheckModifierKey = -1 then the return occur when the "modifier key" is pressed.

See Also

Search GetAsyncKeyState in MSDN Library.

Example

Example 1 : _Ispressed using $vkey as string

#include <Misc.au3>
#include <MsgBoxConstants.au3>
#include <WinAPIvkeysConstants.au3>
Local $hDLL= DllOpen ("user32.dll")
While 1
If _IsPressed ("10",$hDLL)Then
ConsoleWrite ("_IsPressed - Shift Key was pressed. @extended = "&@extended &@CRLF )
; Wait until key is released.
While _IsPressed ("10",$hDLL)
Sleep (100)
WEnd
ConsoleWrite ("_IsPressed - Shift Key was released. @extended = "&@extended &@CRLF )
ElseIf _IsPressed ("1B",$hDLL)Then
ConsoleWrite ("_IsPressed - Esc Key was pressed. @extended = "&@extended &@CRLF )
MsgBox ($MB_SYSTEMMODAL,"_IsPressed","The Esc Key was pressed, therefore we will close the application.",3)
ExitLoop
EndIf
Sleep (100)
WEnd
DllClose ($hDLL)

Example 2 : _IsPressed using $vkey as array with modifier key checking

#include <Misc.au3>
#include <MsgBoxConstants.au3>
#include <WinAPIvkeysConstants.au3>
Local $asModifierKeys[6]= [0,"VK_SHIFT","VK_CONTROL","VK_MENU","VK_LWIN","VK_RWIN"]
Local $aKeys[3]= [$VK_ESCAPE,$VK_LBUTTON,$VK_TAB]
While 1
Local $iRet= _IsPressed ($aKeys,Default ,True ); Check modifier
If Not $iRetAnd @extended Then ConsoleWrite ("The modifier key "&$asModifierKeys[@extended ]&" has been pressed. @extended = "&@extended &@CRLF )
Local $sKey
Switch $iRet
Case 1; Keyboard ESC
$sKey= "{ESCAPE}"
ExitLoop
Case 2; MouseClick Left
$sKey= "{LBUTTON}"
ExitLoop
Case 3; Keyboard Tab
$sKey= "{TAB}"
ExitLoop
EndSwitch
Sleep (100)
WEnd
_IsPressed (); to DLLClose the default Dll created by the previous _IsPressed_(...)
Send ("^z"); to avoid change in the Scite Window
ConsoleWrite ("The key "&$sKey&" has been pressed."&@CRLF )
MsgBox ($MB_SYSTEMMODAL,"Result","The key "&$sKey&" has been pressed.",2)

Example 3 : _Ispressed using $vkey as integer with modifier key checking

#include <Misc.au3>
#include <MsgBoxConstants.au3>
#include <WinAPIvkeysConstants.au3>
Example()
Func  Example()
While 1
If _IsPressed ($VK_F2,Default ,True )Then
ConsoleWrite ("_IsPressed - F2 (without any modifier keys pressed) was pressed."&@CRLF )
; Wait until key is released.
While _IsPressed ($VK_F2,Default ,True )
Sleep (100)
WEnd
ConsoleWrite ("_IsPressed - F2 (without any modifier keys pressed) was released."&@CRLF )
ElseIf _IsPressed ($VK_ESCAPE)Then
MsgBox ($MB_SYSTEMMODAL,"_IsPressed","The Esc Key was pressed, therefore we will close the application.",3)
ExitLoop
EndIf
Sleep (100)
WEnd
_IsPressed (); to release the internal handle created by previous call to _IsPressed(...)
EndFunc ;==>Example