RtfwSetTCPIPConfiguration
RtfwSetNALConfiguration sets the configuration of the RT-TCP/IP Stack.
Syntax
bool RtfwSetTCPIPConfiguration(
RTFW_TCPIP_CONFIGURATION * pConfiguration,
);
Parameters
pConfiguration
A pointer to a RTFW_TCPIP_CONFIGURATION structure that specifies the configuration of the RT-TCP/IP Stack. The member Size must be set to sizeof(RTFW_MONITOR_CONFIGURATION), otherwise this API fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.
Return Value
The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.
Possible error codes:
| Error Code | Meaning |
|---|---|
| RT_ERROR_RESTART_NETWORK |
The RT-TCP/IP Stack was running when this function succeeded. RtfwRestartRequired will report that the RT-TCP/IP Stack must be restarted. NOTE: The RT-TCP/IP Stack must be restarted for the changes to take effect. |
| RT_ERROR_STRUCTURE_TOO_SMALL | The Size member of a structure is too small. |
Remarks
The following is the best practice for using Native Library Get/Set APIs that take structures as arguments:
- Call the Get function.
- Modify the value(s) you want to change.
- Call the corresponding Set function.
- Check error returns to see if a component needs to be restarted.
The values passed in by the Set function will be saved (persistent).
If the NAL is running when RtfwSetTCPIPConfiguration is called, the values specified within the structure will not take affect until the NAL is restarted
Requirements
| Minimum Required Version | RTX64 4.0 |
| Header | RtfwAPI.h |
| Library | RtfwAPI.lib |
See Also:
