SimConnect_UnsubscribeToFacilities_EX1
The SimConnect_UnsubscribeToFacilities_EX1 function is used to request that notifications of additions to the facilities cache are not longer sent, with the ability to specify which event should be disabled.
Syntax
HRESULT SimConnect_UnsubscribeToFacilities_EX1(
HANDLE hSimConnect,
SIMCONNECT_FACILITY_LIST_TYPE type,
bool bUnsubscribeNewInRange,
bool bUnsubscribeOldOutRange
);
Parameters
Parameter | Description | Type |
---|---|---|
hSimConnect |
Handle to a SimConnect object. | Integer |
type |
Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type. |
Enum |
bUnsubscribeNewInRange |
Specifies that the "new element in range" event should be disabled. | Bool |
bUnsubscribeOldOutRange |
Specifies that the "element out of range" event should be disabled. | Bool |
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
This is used to terminate notifications generated by the SimConnect_SubscribeToFacilities_EX1
function.
See Also
- SimConnect API Reference
- SimConnect_SubscribeToFacilities_EX1
- SimConnect_RequestFacilitiesList
- SimConnect_UnsubscribeToFacilities