RtfwSetMonitorConfiguration
RtfwSetMonitorConfiguration sets the RTX64 Subsystem’s default Monitoring configuration.
Syntax
bool RtfwSetMonitorConfiguration(
const RTFW_MONITOR_CONFIGURATION * pMonitorConfiguration
);
Parameters
pMonitorConfiguration
A pointer to a RTFW_MONITOR_CONFIGURATION structure that specifies the new Monitoring Framework configuration parameters. The Size member 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_SUBSYSTEM |
The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the Subsystem must be restarted. NOTE: The RTX64 Subsystem must be restarted for the change 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).
Any pathname passed to this function must not be a network pathname. This includes:
- A pathname with a drive letter that specifies a mapped file share.
- A UNC path: a pathname that starts with \\servername.
Requirements
| Minimum Required Version | RTX64 3.4 |
| Header | RtfwAPI.h |
| Library | RtfwAPI.lib |
See Also:
