SimConnect_RemoveInputEvent

The SimConnect_RemoveInputEvent function is used to remove an input event from a specified input group object.

 

Syntax
HRESULT SimConnect_RemoveInputEvent(
      HANDLE  hSimConnect,
      SIMCONNECT_INPUT_GROUP_ID  GroupID,
      const char*  pszInputDefinition
      );

 

Parameters
Parameter Description Type
hSimConnect Handle to a SimConnect object. Integer
GroupID Specifies the ID of the client defined input group from which the event is to be removed. Integer
pszInputDefinition Pointer to a null-terminated string containing the input definition. 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.
E_INVALIDARG A SimConnect section in the SimConnect.cfg file did not contain the config index requested in the parameters.

 

Example
static enum INPUT_ID {
    INPUT_1,
    };
static enum EVENT_ID {
    EVENT_1,
    };
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_1, "parking_brakes");
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "a+B", EVENT_1);
      ....
hr = SimConnect_RemoveInputEvent(hSimConnect, INPUT_1, "a+B");

 

Remarks

The input string definitions must match exactly, before anything is removed from the group definition. For example, the string definitions "A+B" and "a+B" do not match.

 

See Also