RtfwGetWatchdogConfiguration

RtfwGetWatchdogConfiguration returns the RTX64 Subsystem watchdog timer configuration.

Syntax

bool RtfwGetWatchdogConfiguration(
    RTFW_WATCHDOG_CONFIGURATION * pWatchdogConfiguration
);

Parameters

pWatchdogConfiguration

A pointer to a RTFW_WATCHDOG_CONFIGURATION structure filled in with the current watchdog timer configuration. The Size member must be set to sizeof(RTFW_WATCHDOG_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, sets the last error value, and leaves the structure pointed to by pWatchdogConfiguration with invalid member content. Call GetLastError for additional error information.

Possible error codes:

Error Code Meaning
RT_ERROR_STRUCTURE_TOO_SMALL The Size member of a structure is too small.

Remarks

If the Subsystem is running when the RtfwSetWatchdogConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum Required Version RTX64 3.4
Header RtfwAPI.h
Library RtfwAPI.lib

See Also:

RTFW_WATCHDOG_CONFIGURATION

RtfwSetWatchdogConfiguration

Runaway Thread Management