Removes a filter on a data item.
SMC_RETURN_CODE smc_drop_filter (SMC_CONNECT_ID clientId, SMC_VIEW_ID viewId, SMC_FILTER_ID filterId)
identifies the connection.
identifies a view created on the connection.
identifies the filter to be dropped.
Return value |
Indicates |
|---|---|
SMC_RET_SUCCESS |
Function succeeded. |
SMC_RET_FAILURE |
Function failed. |
SMC_RET_INVALID_CONNECT |
Connection does not exist. |
The following example assumes that:
You have created a connection and have a clientId.
You have created a view on that connection and have a viewId.
You have created a filter on that view and have a filterId.
if (smc_drop_filter(clientId,
viewId,
filterId) != SMC_RET_SUCCESS)
{
printf("smc_drop_filter_failed\n");
/* do some cleanup */
}
Dropping a filter takes effect at the next call to smc_refresh following the call to smc_drop_filter.
You cannot drop a filter created while defining a Historical Server session (that is, when the connection mode is SMC_SERVER_M_HISTORICAL).
Mode |
Availability |
|---|---|
SMC_SERVER_M_LIVE |
Yes |
SMC_SERVER_M_HISTORICAL |
No |
Error |
Indicates |
|---|---|
SMC_RET_INVALID_VIEWID |
View does not exist. |
SMC_RET_INVALID_FILTERID |
Filter does not exist. |
smc_create_filter, smc_drop_view
