formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Utility

# fzrt_evnt_get_actual_key_state

Description

Get the pressed state of a key. This will return the state of the specified virtual key. Currently this is only implemented for the modifier keys Note that this return the key pressed state of the actual keys and not the virtual modifier keys that are used to make cross-platform key equivalents consistent.

Plugin Prototype

fzrt_error_td fzrt_evnt_get_actual_key_state(

fzrt_evnt_virtual_key_enum | virt_key,
fzrt_key_state_enum * | state )

Parameters

virt_key [Input]

virtual key code

state [Result]

pointer to fzrt_unsigned_int that receives the state of key.

Returns

FZRT_NOERR on success, an error id otherwise.

Availability

5.0.0.0

See Also

fzrt_evnt_get_key_state

Function Set

fz_fzrt_util_fset

Defined in

fzrt_api.h