Rediger

Del via


RtmCloseEnumerationHandle 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 RtmCloseEnumerationHandle terminates a specified enumeration and frees the associated resources.

Syntax

DWORD RtmCloseEnumerationHandle(
  _In_ HANDLE EnumerationHandle
);

Parameters

EnumerationHandle [in]

Handle to the enumeration to terminate. Obtain this handle by calling RtmCreateEnumerationHandle.

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_INVALID_HANDLE
The parameter is not valid.
ERROR_NO_SYSTEM_RESOURCES
There are insufficient resources to carry out the operation.

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

RtmEnumerateGetNextRoute