RtmDeregisterEntity function (rtmv2.h)

The RtmDeregisterEntity function unregisters a client from a routing table manager instance and address family.

Syntax

DWORD RtmDeregisterEntity(
  [in] RTM_ENTITY_HANDLE RtmRegHandle
);

Parameters

[in] RtmRegHandle

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

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.

Remarks

Before calling this function, the client must ensure that all locks, handles, and information structures are released with the appropriate functions.

When the client calls RtmDeregisterEntity, the handle that was returned by a previous call to RtmRegisterEntity is released. The client must not call any RTMv2 functions after releasing this handle.

If the client does call any functions that access the routing table manager after the client has unregistered, the client's process may be terminated.

Requirements

See also

RtmRegisterEntity