大网数据广告活动
网络与域名解析

RtmBlockDeleteRoutes function (Rtm.h)

· 52CE 我爱测

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

[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
ERROR_NO_ROUTES There are no routes that have 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, the enumeration flags are invalid.
ERROR_NO_SYSTEM_RESOURCES There are insufficient resources to carry out the operation.
ERROR_NOT_ENOUGH_MEMORY 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 Rtm.h
Library Rtm.lib
DLL Rtm.dll

See also

Routing Table Manager Version 1 Reference

Routing Table Manager Version 1 Functions

RtmCreateEnumerationHandle

RtmRegisterClient

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 05/31/2018
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。