formZ SDK | 5.0 API Reference | System | User Interface (FUIM)

# fz_fuim_key_cancel

Description

Checks for user cancel of operation. This function checks to see if the user has pressed the cancel key shortcut or the cancel button of a progress bar. It should be called at strategic places in code that could take a fzrt_int time to execute and it is desirable to have the ability for the user to interrupt the task being performed. This function should not be called too frequently as it can affect performance. This function will only return TRUE once per cancel operation so it is important that every call to the function catches the cancel and handles it appropriately.
The cancel key shortcut is defined by the user in the shortcut manager dialog. By default the key is a cancel shortcut on all platforms. On Macintosh, the Command + '.' (period) keys is also a default cancel shortcut. On Windows control + 'c' key is also a default cancel shortcut.

Plugin Prototype

fzrt_boolean fz_fuim_key_cancel(void)

Returns

TRUE if cancel has been requested, FALSE if cancel has not been requested.

Availability

5.0.0.0

See Also

fz_fuim_curs_wait

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h