RtmCloseEnumerationHandle

[This is preliminary documentation and subject to change.]

The RtmCloseEnumerationHandle terminates a specified enumeration and frees the associated resources.

DWORD RtmCloseEnumerationHandle(
  HANDLE   EnumerationHandle  // handle that identifies enumeration
);
 

Parameters

EnumerationHandle

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

Return Values

NO_ERROR

The enumeration was terminated successfully.

ERROR_INVALID_HANDLE

The EnumerationHandle parameter is not a valid.

ERROR_NO_SYSTEM_RESOURCES

Insufficient resources to carry out the operation.

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, RtmEnumerateGetNextRoute