SimConnect_SetInputGroupPriority
The SimConnect_SetInputGroupPriority function is used to set the priority for a specified input group object.
Syntax
RESULT SimConnect_SetInputGroupPriority(
HANDLE hSimConnect,
SIMCONNECT_INPUT_GROUP_ID GroupID,
DWORD uPriority
);
Parameters
Parameter | Description | Type |
---|---|---|
hSimConnect | Handle to a SimConnect object. | Integer |
GroupID | Specifies the ID of the client defined input group that the priority setting is to apply to. | Integer |
uPriority | Specifies the priority setting for the input group. See the explanation of SimConnect Priorities. | 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
hr=SimConnect_SetInputGroupPriority(hSimConnect,INPUT0,SIMCONNECT_GROUP_PRIORITY_HIGHEST);
Remarks
A priority setting must be made for all input groups, otherwise event notifications will not be sent by the SimConnect server.
See Also
- SimConnect API Reference
- SimConnect_MapInputEventToClientEvent
- SimConnect_RemoveInputEvent
- SimConnect_ClearInputGroup
- SimConnect_SetInputGroupState