Editing getAsyncKeyStateF - FilterMeisterWiki

When saving, enter the following:

  _____ TT  TT   __     __         ####     
 |__  / TT  TT   \ \   / /|\     /| ##      
   / /  TT  TT    \ \_/ / | )   ( | ##      
  / /_  TT  TT     \   /  | |   | | ##      
 /____| TT  TT      | |   | |   | | ##      
        TT  TT      |_|   | |   | | ##      
         TTTT             | (___) |#######  
                          (_______)

Visit Preferences to set your user name

= getAsyncKeyStateF =

== Syntax ==
{{int fm_getAsyncKeyStateF(int vkey)}}

== Arguments ==
:'''vkey'''
::Virtual Key Constant. For more information see the [https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes MSDN Virtual Key Codes page]

== Return ==
The return value specifies whether the key was pressed since the last call to a member of the getAsyncKeyState family of functions, and whether the key is currently up or down. If the most significant bit is set, the key is down, and if the least significant bit is set, the key was pressed after the previous call to GetAsyncKeyState.
getAsyncKeyStateF also checks if the window is currently active. If not, all keys will be seen as "up" (that is; not pressed).

== Description ==
Determines whether a key is up or down at the time the function is called, and whether the key was pressed after a previous call to getAsyncKeyState.

== Example ==
<code>
%ffp

ctl(10): PUSHBUTTON, Text="Hold down the CTRL key"
         "and click me", Pos=(250, 50), Size=(150, 15)

OnCtl(n): 
{
  int r;
	
  if (n == 10 && e == FME_CLICKED)  {
		
    if (getAsyncKeyStateF(VK_CONTROL) < 0)
      Info ("The Control Key was just pressed.");	
    else
      ErrorOk ("You didn't press the Control Key.");

}
	
  return false;
}
</code>

== See Also ==
((FME_KEYDOWN)), ((FME_KEYUP)), ((getAsyncKeyState)), ((VK codes))

Summary of change:
Add document to category: