Native Framework Library Functions

The RTX64 Native Framework Library functions are listed below in the following groups:

• Configuring the Subsystem
• Configuring the Network
• Starting/Stopping the Subsystem and/or Network
• Devices
• Monitoring
• Scheduled Processes
• Configuring the RTX64 Real-Time Output Console

 

Configuring the Subsystem

Function	Description
RtfwGetSubsystemConfiguration	Returns the core RTX64 Subsystem configuration. See structure RTFW_SUBSYSTEM_CONFIGURATION. Other Subsystem configuration parameters can be obtained using other functions in this library.
RtfwSetSubsystemConfiguration	Modifies the core RTX64 Subsystem configuration parameters. See structure RTFW_SUBSYSTEM_CONFIGURATION. Other subsystem configuration parameters can be modified using other functions in this library.
RtfwGetProcessorConfiguration	Returns the processor configuration of the RTX64 Subsystem
RtfwSetProcessorConfiguration	Configures the processor configuration of the RTX64 Subsystem.
RtfwGetExceptionHandling	Returns the current exception handling configuration of the RTX64 Subsystem.
RtfwSetExceptionHandling	Sets the exception handling configuration of the RTX64 Subsystem.
RtfwGetLocalMemoryConfiguration	Returns the Local Memory pool configuration for the RTX64 Subsystem.
RtfwSetLocalMemoryConfiguration	Sets the Local Memory pool configuration for the RTX64 Subsystem.
RtfwGetPriorityInversionProtocol	Returns the RTX64 Subsystem priority inversion protocol.
RtfwSetPriorityInversionProtocol	Sets the RTX64 Subsystem priority inversion protocol.
RtfwGetSearchPath	Returns the list of directories to be searched by the RTX64 Subsystem when loading an RTDLL or launching an RTSS application without specifying an absolute pathname to the RTDLL or RTSS file. Each directory is separated by a ';' character.
RtfwSetSearchPath	Sets the list of directories to be searched by the RTX64 Subsystem when loading an RTDLL or launching an RTSS application without specifying an absolute pathname to the RTDLL or RTSS file.
RtfwGetWatchdogConfiguration	Returns the RTX64 Subsystem watchdog timer configuration.
RtfwSetWatchdogConfiguration	Configures the RTX64 Subsystem watchdog timer configuration.
RtfwGetWindowsEnergyPerformanceBias	Reads the current configuration for the WindowsEnergyPerformanceBias feature and fills pWindowsPerformanceBias with the value.
RtfwSetWindowsEnergyPerformanceBias	Sets the configuration for the WindowsEnergyPerformanceBias feature.
RtfwGetWindowsIdleDetection	Returns whether or not the RTX64 Subsystem disables Windows idle detection power optimization while the RTX64 Subsystem is running.
RtfwSetWindowsIdleDetection	Configures whether or not the RTX64 Subsystem disables Windows idle detection power optimization while the RTX64 Subsystem is running.

Configuring the Network

Function	Description
RtfwGetNetworkConfiguration	Returns the configuration of the RT-TCP/IP Stack.
RtfwSetNetworkConfiguration	Sets the configuration of the RT-TCP/IP Stack.
RtfwGetNetworkStatus	Returns whether or not the RT-TCP/IP Stack is started.
RtfwGetAllNetworkInterfaces	Returns the configurations of all RTX64 network interfaces.
RtfwGetNetworkInterfaceByName	Returns the configuration of an RTX64 network interface associated with a given friendly name.
RtfwCreateNetworkInterface	Creates a new RTX64 network interface.
RtfwModifyNetworkInterface	Modifies the configuration of an existing real-time network interface in the RT-TCP/IP Stack.
RtfwDeleteNetworkInterface	Deletes an existing real-time network interface in the RT-TCP/IP Stack.

Starting/Stopping the Subsystem and/or Network

Function	Description
RtfwGetSubsystemStatus	Returns the current status of the RTX64 Subsystem.
RtfwStartSubsystem	Starts the RTX64 Subsystem.
RtfwStopSubsystem	Stops the RTX64 Subsystem and RT-TCP/IP Stack (if it is running).
RtfwGetNetworkStatus	Returns whether or not the RT-TCP/IP Stack is started.
RtfwStartNetwork	Starts the RT-TCP/IP Stack.
RtfwStopNetwork	Stops the RT-TCP/IP Stack.
RtfwRestartRequired	Returns whether the RTX64 Subsystem, the RT-TCP/IP Stack, or Windows needs to be restarted after a configuration change has been made using the RTX64 Native Framework or the RTX64 Control Panel.

Devices

Function	Description
RtfwGetRTX64Devices	Enumerates RTX64-owned devices.

Monitoring

Function	Description
RtfwGetMonitorConfiguration	Returns the current RTX64 Monitoring Framework configuration parameters.
RtfwSetMonitorConfiguration	Sets the RTX64 Monitoring configuration parameters.
RtfwGetMonitorStatus	Returns the current status of RTX64 Monitoring.
RtfwEnableMonitoring	Enables the RTX64 Monitoring support within the Subsystem.
RtfwDisableMonitoring	Disables the RTX64 Monitoring support within the Subsystem.
RtfwStartMonitoring	Starts RTX64 Monitoring.
RtfwStopMonitoring	Stops RTX64 Monitoring.
RtfwDeleteMonitorSession	Deletes the specified RTX64 Monitoring session folder.
RtfwDeleteAllMonitorSessions	Deletes all RTX64 Monitoring session folders located in the session parent folder configured by RtfwSetMonitorConfiguration.
RtfwGetMonitorEventStates	Returns the enabled/disabled state of every kind of monitoring event that can be generated by the RTX64 Monitoring Framework.
RtfwSetMonitorEventStates	Enables and disables RTX64 Monitoring events in the Persistent Event Set.
RtfwSetAllMonitorEventStates	Enables or disables all RTX64 Monitoring events.

Configuring the RTX64 Real-Time Output Console

Function	Description
RtfwGetConsoleConfiguration	Retrieves the configuration of the RTX64 real-time output console.
RtfwSetConsoleConfiguration	Configures the RTX64 real-time output console.