RtfwrlyGetConfiguration
RtfwrlyGetConfiguration returns the Network Relay configuration.
Syntax
bool RtfwrlyGetConfiguration(
[in, out] RTFW_RLY_CONFIGURATION * pConfiguration
);Parameters
[in, out] pConfiguration
A pointer to a RTFW_RLY_CONFIGURATION structure that is filled in with the current Network Relay configuration. The member Size must be set to sizeof(RTFW_RLY_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 Network Relay component is running when RtfwrlyGetConfiguration is called, the values returned by this function may differ from the values currently in use by the Subsystem when you call RtfwrlyGetConfiguration before restarting the Network Relay component.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtfwrlyApi.h |
RtfwrlyApi.lib |
See Also:
