Rtfwnl2GetConfiguration

Rtfwnl2GetConfiguration returns the configuration of the Network Link Layer (NL2).

Syntax

Copy

bool Rtfwnl2GetConfiguration(
    [in, out] RTFW_NL2_CONFIGURATION * pConfiguration
);

Parameters

[in, out] pConfiguration

A pointer to a RTFW_NL2_CONFIGURATION structure that is filled in with the current NL2 configuration. The member Size must be set to sizeof(RTFW_NL2_CONFIGURATION), otherwise this API 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 does not populate the structure pointed to by pConfiguration with valid 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.

Remarks

If the NL2 is running when Rtfwnl2GetConfiguration is called, the values returned by this function may differ from the values currently in use by the Subsystem when you call Rtfwnl2GetConfiguration before restarting the NL2.

Requirements

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