SimConnect_EnumerateInputEvents
The SimConnect_EnumerateInputEvents function is used to retrieve a paginated list of all available InputEvents for the current aircraft along with their associated hash (CRC based).
Syntax
HRESULT SimConnect_EnumerateInputEvents(
HANDLE hSimConnect,
SIMCONNECT_DATA_REQUEST_ID RequestID
)
Parameters
Parameter | Description | Type |
---|---|---|
hSimConnect |
Handle to a SimConnect object. | Integer |
RequestID |
The ID that will identify the current request in the response event | 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 :
- SIMCONNECT_EXCEPTION_ERROR in the case of internal errors (see SIMCONNECT_EXCEPTION)
Remarks
With this function you can request data on the input events currently available for the current SimObject. The function will trigger one or more SIMCONNECT_RECV_ENUMERATE_INPUT_EVENTS
responses, and in this response struct you will find the rgData
member, which has a list of SIMCONNECT_INPUT_EVENT_DESCRIPTOR
structs, where each struct represents an input event, for example:
{ INPUT_EVENT_NAME_1; hash_1 } { INPUT_EVENT_NAME_2; hash_2 } { INPUT_EVENT_NAME_3; hash_3 } // etc...
See Also