[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 RtmDeregisterClient function deregisters the client, and frees resources associated with the client.
Syntax
DWORD RtmDeregisterClient(
_In_ HANDLE ClientHandle
);
Parameters
ClientHandle [in]
Handle that identifies the client to deregister. Obtain this handle by calling RtmRegisterClient.
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 ClientHandle parameter is not a valid handle. |
| ERROR_NO_SYSTEM_RESOURCES | Insufficient resources to carry out the operation. |
Remarks
This function removes all routes that were added by the client.
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
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.
