RtfwGetNetworkInterfaceByName

RtfwGetNetworkInterfaceByName returns the configuration of an RTX64 network interface associated with a given friendly name.

Syntax

bool RtfwGetNetworkInterfaceByName(
    const TCHAR * friendlyName,
    RTFW_NETWORK_INTERFACE * pInterface,
    unsigned int reserved
);

Parameters

friendlyName

A pointer to the friendly name of an existing network interface. This value is not case sensitive.

pInterface

A pointer to structure RTFW_NETWORK_INTERFACE that is filled with configuration information for the network interface. This value cannot be NULL, and member Size must be set to sizeof(RTFW_NETWORK_INTERFACE), otherwise this function fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

reserved

This parameter must always be set to zero.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the structure referenced by pInterface with invalid member values. 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_STRUCTURE_TOO_SMALL	The Size member of a structure is too small.

Remarks

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

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