SetStoreCapsLockMode

Whether to restore the state of CapsLock after a Send.

SetStoreCapsLockMode Mode

Parameters

Mode

Type: Boolean

If true, CapsLock will be restored to its former value if Send needed to change it temporarily for its operation.

If false, the state of CapsLock is not changed at all. As a result, Send will invert the case of the characters if CapsLock happens to be ON during the operation.

Return Value

Type: Integer (boolean)

This function returns the previous setting; either 0 (false) or 1 (true).

Remarks

If SetStoreCapsLockMode is not used, the default setting is 1 (true).

This means that CapsLock will not always be turned off for Send and ControlSend. Even when it is successfully turned off, it might not get turned back on after the keys are sent.

This function is rarely used because the default behavior is best in most cases.

This setting is ignored by blind mode and text mode; that is, the state of CapsLock is not changed in those cases.

The built-in variable A_StoreCapsLockMode contains the current setting (1 or 0).

Every newly launched thread (such as a hotkey, custom menu item, or timed subroutine) starts off fresh with the default setting for this function. That default may be changed by using this function during script startup.

SetCaps/Num/ScrollLockState, Send, ControlSend

Examples

Causes the state of CapsLock not to be changed at all.

SetStoreCapsLockMode False