SimConnect_ClearAllFacilityDataDefinitionFilters
The SimConnect_ClearAllFacilityDataDefinitionFilters function is used to clear all applied facility definition filters.
Syntax
HRESULT SimConnect_ClearAllFacilityDataDefinitionFilters(
HANDLE hSimConnect,
SIMCONNECT_DATA_DEFINITION_ID DefineID
);
Parameters
| Parameter | Description | Type |
|---|---|---|
hSimConnect |
Handle to a SimConnect object. | Integer |
DefineID |
Specifies the ID of the client defined data definition. | 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. |
This function might throw the following exception:
SIMCONNECT_EXCEPTION_UNRECOGNIZED_ID(offset == 1) - if the DefineID is not recognized
Remarks
Please see SimConnect_AddFacilityDataDefinitionFilter for details on creating filters, and see the accompanying examples for details on how to clear a single filter.
See Also