SimConnect_SetNotificationGroupPriority
The SimConnect_SetNotificationGroupPriority
function is used to set the priority for a notification group.
Syntax
HRESULT SimConnect_SetNotificationGroupPriority(
HANDLE hSimConnect,
SIMCONNECT_NOTIFICATION_GROUP_ID GroupID,
DWORD uPriority
);
Parameters
Parameter | Description | Type |
---|---|---|
hSimConnect | Handle to a SimConnect object. | Integer |
GroupID | Specifies the ID of the client defined group. | Integer |
uPriority | Requests the group's priority. 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_SetNotificationGroupPriority(hSimConnect, GROUP0, SIMCONNECT_GROUP_PRIORITY_HIGHEST);
Remarks
See SimConnect Priorities for additional information.
See Also
- SimConnect API Reference
- SimConnect_AddClientEventToNotificationGroup
- SimConnect_RemoveClientEvent
- SimConnect_ClearNotificationGroup