RtmBlockDeleteRoutes

[This is preliminary documentation and subject to change.]

The RtmBlockDeleteRoutes function deletes all routes in the specified subset of routes in the table.

HANDLE RtmBlockDeleteRoutes(
  HANDLE  ClientHandle,       // handle that identifies client
  DWORD   EnumerationFlags,   // flags that specify type of criteria
  PVOID   CriteriaRoute       // structure that hold criteria values
);
 

Parameters

ClientHandle

Handle that identifies the client and therefore the routing protocol of the routes to be deleted.

EnumerationFlags

Limits the set of deleted routes to a subset defined by these 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

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 Values

NO_ERROR

The routes were deleted successfully.

ERROR_NO_ROUTES

No routes exist with the specified criteria.

ERROR_INVALID_HANDLE

The ClientHandle parameter is not valid.

ERROR_INVALID_PARAMETER

One or more of the input parameters is invalid (for example, invalid enumeration flags).

ERROR_NO_SYSTEM_RESOURCES

Insufficient resources to carry out the operation.

ERROR_NOT_ENOUGH_MEMORY

Insufficient memory to carry out the operation.

Remarks

The function generates appropriate notification messages to all registered clients including the caller.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in rtm.h.
  Import Library: Link with rtm.lib.

See Also

RtmCreateEnumerationHandle, RtmRegisterClient