RtmDeleteEnumHandle function (rtmv2.h)

The RtmDeleteEnumHandle function deletes the specified enumeration handle and frees all resources allocated for the enumeration.

Syntax

DWORD RtmDeleteEnumHandle(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_ENUM_HANDLE   EnumHandle
);

Parameters

[in] RtmRegHandle

Handle to the client obtained from a previous call to RtmRegisterEntity.

[in] EnumHandle

Handle to be released. Any resources associated with the handle are also freed.

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 Meaning
ERROR_INVALID_HANDLE
The handle is invalid.
 
 

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header rtmv2.h
Library Rtm.lib
DLL Rtm.dll

See also

RtmCreateDestEnum

RtmCreateNextHopEnum

RtmCreateRouteEnum

RtmCreateRouteListEnum

RtmGetEnumDests

RtmGetEnumNextHops

RtmGetEnumRoutes

RtmReleaseDests

RtmReleaseNextHops

RtmReleaseRoutes