RtfwDeleteNetworkInterface

RtfwDeleteNetworkInterface deletes an existing real-time network interface in the RT-TCP/IP Stack.

Syntax

bool RtfwDeleteNetworkInterface(
    const TCHAR * friendlyName,
    unsigned int reserved
);

Parameters

friendlyName

A pointer to the friendly name of the interface to be deleted, This is the same as the FriendlyName member of the RTFW_NETWORK_INTERFACE structure. Note that friendlyName is not case sensitive.

reserved

This parameter must always be set to zero.

Return Value

The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.

Possible error codes:

Error Code	Meaning
RT_ERROR_NETWORK_NOT_INSTALLED	The RT-TCP/IP Stack is not installed.
RT_ERROR_REGISTRY_MISSING	A registry key or value is missing.
RT_ERROR_RESTART_NETWORK	The RT-TCP/IP Stack was running when this function succeeded. RtfwRestartRequired will report that the RT-TCP/IP Stack must be restarted. NOTE: The RT-TCP/IP Stack must be restarted for the change to take effect.

Error Code

Meaning

RT_ERROR_NETWORK_NOT_INSTALLED

The RT-TCP/IP Stack is not installed.

RT_ERROR_REGISTRY_MISSING

A registry key or value is missing.

RT_ERROR_RESTART_NETWORK

The RT-TCP/IP Stack was running when this function succeeded. RtfwRestartRequired will report that the RT-TCP/IP Stack must be restarted.

NOTE: The RT-TCP/IP Stack must be restarted for the change to take effect.

Remarks

Any pathname passed to this function must not be a network pathname. This includes:

A pathname with a drive letter that specifies a mapped file share.
A UNC path: a pathname that starts with \\servername.

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib