INNER CODE UNIT · Python
add_hotstring
spyoungtech/ahk · ahk/_async/engine.py:228
def add_hotstring(
self,
trigger: str,
replacement_or_callback: Union[str, Callable[[], Any]],
ex_handler: Optional[Callable[[str, Exception], Any]] = None,
options: str = '',
) -> None:
"""
Register a hotstring, e.g., `::btw::by the way`
Key notes:
- You must call the `start_hotkeys` method for registered hotstrings to be active
- All hotstrings (and hotkeys) run in a single AHK process instance separate from other AHK processes.
:param trigger: the trigger phrase for the hotstring, e.g., ``btw``
:param replacement_or_callback: the replacement phrase (e.g., ``by the way``) or a Python callable to execute in response to the hotstring trigger
:param ex_handler: a function which accepts two parameters: the hotstring and the exception raised by the callback function.