SimConnect_ClearInputGroup

The SimConnect_ClearInputGroup function is used to remove all the input events from a specified input group object.

Syntax

HRESULT SimConnect_ClearInputGroup(
    HANDLE  hSimConnect,
    SIMCONNECT_INPUT_GROUP_ID  GroupID
    );

Parameters

Parameter	Description	Type
hSimConnect	Handle to a SimConnect object.	Integer
GroupID	Specifies the ID of the client defined input group that is to have all its events removed.	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.

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_ClearInputGroup(hSimConnect, INPUT_1);

Remarks