trigger_key_event_EX1

The trigger_key_event_EX1 function initiates the action of a key event, passing in up to 5 optional parameters.

IMPORTANT! This function replaces the deprecated send_key_event and trigger_key_event functions.

 

Syntax
ERR trigger_key_event_EX1(
    ID32  event_id,
    UINT32 value0,
    UINT32 value1,
    UINT32 value2,
    UINT32 value3,
    UINT32 value4
    );

 

Members
Parameters Description
event_id Specifies the event ID. Refer to the list of key events in the EventIDs document, and the #define KEY_events in gauges.h.
value0 - value4 Specifies up to 5 additional integer values. Set this to zero if it is not required.
 
Return Values

The function returns an ERR, which is usually ignored. If the event requested is not appropriate, it will simply not happen.

 

 

Example
trigger_key_event_EX1(KEY_ELECTRICAL_CIRCUIT_BREAKER_TOGGLE, 1, 1);

 

 

Remarks

You do not need to supply all 5 possible arguments, only those that are required for the key event being processed. Events triggered in this way will have the SIMCONNECT_RECV_ID_EVENT_EX1 ID.

 

 

See Also