SimConnect_RequestNotificationGroup
The SimConnect_RequestNotificationGroup function is used to request events are transmitted from a notification group, when the simulation is in Dialog Mode.
Syntax
HRESULT SimConnect_RequestNotificationGroup(
HANDLE hSimConnect,
SIMCONNECT_NOTIFICATION_GROUP_ID GroupID,
DWORD dwReserved = 0,
DWORD Flags = 0
);
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 |
dwReserved | Reserved for future use. | N/A |
Flags | Reserved for future use. | N/A |
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. |
Remarks
In this version this function has the specific purpose of enabling the sending of events, particularly joystick events, when the simulation is in Dialog Mode.
See Also
- SimConnect API Reference
- SimConnect_AddClientEventToNotificationGroup
- SimConnect_SetNotificationGroupPriority
- SimConnect_ClearNotificationGroup