SimConnect_SubscribeInputEvent

The SimConnect_SubscribeInputEvent function is used to subscribe an input event and generate when the value changes.

 

Syntax

HRESULT SimConnect_SubscribeInputEvent(
    HANDLE hSimConnect,
    UINT64 Hash,
)

 

Parameters

Parameter	Description	Type
hSimConnect	Handle to a SimConnect object.	Integer
Hash	Hash ID that will identify the desired input event to subscribe to. You can use 0 here to subscribe to all input events.	Integer

 

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value	Description
S_OK	The function succeeded.
E_FAIL	The function failed.

 

This function might throw one of the following SIMCONNECT_EXCEPTION:

• SIMCONNECT_EXCEPTION_ERROR in case of internal errors
• SIMCONNECT_EXCEPTION_GET_INPUT_EVENT_FAILED if the given hash in wrong

 

Remarks

This function will subscribe to a specific input event based on the given hash (you can retrieve the input event hashes using SimConnect_EnumerateInputEvents). You may also supply 0 (null) as the hash value, in which case you will be subscribing to all input events. The function will generate one or more SIMCONNECT_RECV_SUBSCRIBE_INPUT_EVENT structs.

NOTE: If you are using C# please see the Note for C#.

 

See Also

• SimConnect API Reference
• SimConnect_UnsubscribeInputEvent
• SIMCONNECT_RECV_SUBSCRIBE_INPUT_EVENT