SimConnect_ClearNotificationGroup
The SimConnect_ClearNotificationGroup function is used to remove all the client defined events from a notification group.
Syntax
HRESULT SimConnect_ClearNotificationGroup(
HANDLE hSimConnect,
SIMCONNECT_NOTIFICATION_GROUP_ID GroupID
);
Parameters
| Parameter | Description | Type |
|---|---|---|
| hSimConnect | Handle to a SimConnect object. | Integer |
| GroupID | Specifies the ID of the client defined 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 EVENT_ID {
EVENT_1,
EVENT_2
EVENT_3
};
static enum GROUP_ID {
GROUP_1,
};
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_1);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_2);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_3, TRUE);
hr = SimConnect_ClearNotificationGroup(hSimConnect, GROUP_1);
Remarks
There is a maximum of 20 notification groups in any SimConnect client. Use this function if the maximum has been reached, but one or more are not longer required.