KeyHistory

Displays script info and a history of the most recent keystrokes and mouse clicks.

KeyHistory MaxEvents

Parameters

MaxEvents

Type: Integer

Omit this parameter to show the script's main window, equivalent to selecting the "View->Key history" menu item.

Otherwise, this parameter sets the maximum number of keyboard and mouse events that can be recorded for display in the window (default 40, limit 500). The key history is also reset, but the main window is not shown or refreshed. Specify 0 to disable key history entirely.

Remarks

To disable key history, use the following:

KeyHistory 0

This feature is intended to help debug scripts and hotkeys. It can also be used to detect the scan code of a non-standard keyboard key using the steps described at the bottom of the key list page (knowing the scan code allows such a key to be made into a hotkey).

The virtual key (VK) of the wheel events (WheelDown, WheelUp, WheelLeft, and WheelRight) are placeholder values that do not have any meaning outside of AutoHotkey. Also, the scan code for wheel events is actually the number of notches by which the wheel was turned (typically 1).

If the script does not have the keyboard hook installed, the KeyHistory window will display only the keyboard events generated by the script itself (i.e. not the user's). If the script does not have the mouse hook installed, mouse button events will not be shown. You can find out if your script uses either hook via "View->Key History" in the script's main window (accessible via "Open" in the tray icon). You can force the hooks to be installed by adding either or both of the following lines to the script:

InstallKeybdHook
InstallMouseHook

Because each keystroke or mouse click consists of a down-event and an up-event, KeyHistory displays only half as many "complete events" as specified by MaxEvents. For example, if the script calls KeyHistory 50, up to 25 keystrokes and mouse clicks will be displayed.

InstallKeybdHook, InstallMouseHook, ListHotkeys, ListLines, ListVars, GetKeyState, KeyWait, A_PriorKey

Examples

Displays the history info in a window.

KeyHistory

Causes KeyHistory to display the last 100 instead 40 keyboard and mouse events.

KeyHistory 100

Disables key history entirely.

KeyHistory 0