RtfwrlySetInterfaceSettings

RtfwrlySetInterfaceSettings sets the configuration of a Network Relay interface.

Syntax

Copy

bool RtfwrlySetInterfaceSettings(
    [in]  const RTFW_RLY_INTERFACE * pRLYInterface,
    [in]  bool ignoreProtocolValidationError,
    [out] bool * pProtocolInvalidated
);

Parameters

[in] pRLYInterface

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

[in] ignoreProtocolValidationError

If TRUE, this API will not fail when these changes invalidate another protocol's configuration settings on this interface. Otherwise, it will fail.

[out] pProtocolInvalidated

Set to TRUE if the configuration settings of another protocol are invalidated by this API. Otherwise, it will be set to false.

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 pRLYInterface with undefined 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.
RTRLY_ERROR_RESTART_NEEDED	A parameter value was changed while the Network Relay was running. Restart the Network Relay to apply the new value.

Remarks

If the Network Relay component is running when RtfwrlySetInterfaceSettings is called, the function will return TRUE and set the last error to RTRLY_ERROR_RESTART_NEEDED. The values specified within the structure will not take effect until the Network Relay component is restarted.

Requirements

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