RtfwSetWatchdogConfiguration
RtfwSetWatchdogConfiguration configures the RTX64 Subsystem watchdog timer configuration.
Syntax
bool RtfwSetWatchdogConfiguration(
const RTFW_WATCHDOG_CONFIGURATION * pWatchdogConfiguration
);
Parameters
pWatchdogConfiguration
A pointer to a RTFW_WATCHDOG_CONFIGURATION structure with members that specify the watchdog timer configuration. Member Size must be set by the caller to the value sizeof(RTFW_WATCHDOG_CONFIGURATION), otherwise this function 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 and sets the last error value. Call GetLastError for additional error information.
Possible error codes:
| Error Code | Meaning |
|---|---|
| ERROR_INVALID_PARAMETER | Member WatchdogTimeout in structure RTFW_WATCHDOG_CONFIGURATION is less than 1000, or not a multiple of the HAL timer period. |
| RT_ERROR_RESTART_SUBSYSTEM |
The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the RTX64 Subsystem must be restarted. NOTE: The RTX64 Subsystem 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.
The values passed in by the Set function will be saved (persistent).
Requirements
| Minimum Required Version | RTX64 3.4 |
| Header | RtfwAPI.h |
| Library | RtfwAPI.lib |
See Also:
