SimConnect_UnsubscribeInputEvent
The SimConnect_UnsubscribeInputEvent function is used to unsubscribe from an input event that has previously been subscribed to.
Syntax
HRESULT SimConnect_UnsubscribeInputEvent(
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 unsubscribe from. You can use 0 here to unsubscribe from 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. |
Remarks
This function will unsubscribe from 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 unsubscribing from all input events. The function generates no response event.