RtmBlockDeleteRoutes function
[This API has been superseded by the Routing Table Manager Version 2 API and will not be available beyond Windows Server 2003. Applications should use the Routing Table Manager Version 2 API.]
The RtmBlockDeleteRoutes function deletes all routes in the specified subset of routes in the table.
Syntax
HANDLE RtmBlockDeleteRoutes(
_In_ HANDLE ClientHandle,
_In_ DWORD EnumerationFlags,
_In_ PVOID CriteriaRoute
);
Parameters
-
ClientHandle [in]
-
Handle that identifies the client, and therefore the routing protocol, of the routes to be deleted.
-
EnumerationFlags [in]
-
Specifies which routes should be enumerated. This parameter limits the set of deleted routes to a subset defined by the following flags and the values in the corresponding members of the structure pointed to by the CriteriaRoute parameter. The flags are the same as those used in RtmCreateEnumerationHandle except that RTM_ONLY_BEST_ROUTES is redundant for RtmBlockDeleteRoutes. The best-route designation is adjusted as routes are deleted, so the function eventually deletes all the routes in the subset.
-
CriteriaRoute [in]
-
Pointer to a protocol-family-specific route structure ( RTM_IP_ROUTE or RTM_IPX_ROUTE). The member values in this structure correspond to the flags specified by the EnumerationFlags parameter.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Value | Description |
|---|---|
|
There are no routes that have the specified criteria. |
|
The ClientHandle parameter is not valid. |
|
One or more of the input parameters is invalid, for example, the enumeration flags are invalid. |
|
There are insufficient resources to carry out the operation. |
|
There is insufficient memory to carry out the operation. |
Remarks
The function generates appropriate notification messages to all registered clients including the caller.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
None supported |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| End of server support |
Windows Server 2003 |
| Header |
|
| Library |
|
| DLL |
|