SimConnect_UnsubscribeToFacilities
The SimConnect_UnsubscribeToFacilities function is used to request that notifications of additions to the facilities cache are not longer sent.
Syntax
HRESULT SimConnect_UnsubscribeToFacilities(
HANDLE hSimConnect,
SIMCONNECT_FACILITY_LIST_TYPE type
);
Parameters
Parameter | Description | Type |
---|---|---|
hSimConnect | Handle to a SimConnect object. | Integer |
type | Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type. |
Enum |
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
function.
See Also
- SimConnect API Reference
- SimConnect_SubscribeToFacilities
- SimConnect_RequestFacilitiesList
- SimConnect_UnsubscribeToFacilities_EX1