Rtfwnl2GetInterface

Rtfwnl2GetInterface returns the configuration of a Network Link Layer (NL2) interface associated with a given name.

Syntax

Copy

bool Rtfwnl2GetInterface(
    [in]  const TCHAR * Name,
    [out] RTFW_NL2_INTERFACE * pNL2Interface
);

Parameters

[in] Name

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

[out] pNL2Interface

A pointer to structure RTFW_NL2_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_NL2_INTERFACE). Otherwise, this function fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the structure referenced by pNL2Interface with invalid member values. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	The member Size of a structure is too small.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	Rtfwnl2Api.h	Rtfwnl2Api.lib