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 Remote Debugging

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.
RtfwGetEnabledProcessors	Returns the total number of processors that are enabled on the system.
RtfwGetRtssProcessorsActual	Returns the actual number of processors being used by 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
RtfwGetNALConfiguration	Returns the configuration of the Network Abstraction Layer (NAL).
RtfwSetNALConfiguration	Configures the Network Abstraction Layer (NAL).
RtfwGetNALLocalMemoryConfiguration	Returns the local memory configuration of the Network Abstraction Layer (NAL).
RtfwSetNALLocalMemoryConfiguration	Specifies the local memory configuration of the Network Abstraction Layer (NAL).
RtfwGetTCPIPConfiguration	Returns the configuration of the RT-TCP/IP Stack.
RtfwSetTCPIPConfiguration	Configures the RT-TCP/IP Stack.
RtfwGetTCPIPLocalMemoryConfiguration	Returns the local memory configuration of the RT-TCP/IP Stack.
RtfwSetTCPIPLocalMemoryConfiguration	Specifies the local memory configuration of the RT-TCP/IP Stack.
RtfwGetNetworkVerbosity	Returns whether verbosity is enabled or disabled for the network (NAL and TCP/IP Stack).
RtfwSetNetworkVerbosity	Enables or disables verbosity across the network (NAL and TCP/IP Stack).
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.
RtfwDeleteNetworkInterface	Deletes an existing real-time network interface.

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 Network Abstraction Layer (NAL) if it is running.
RtfwStopSubsystemForce	Forces the RTX64 Subsystem to stop.
RtfwGetNALStatus	Returns the status of the Network Abstraction Layer (NAL).
RtfwStartNAL	Starts the Network Abstraction Layer (NAL).
RtfwStopNAL	Stops the Network Abstraction Layer (NAL).
RtfwGetTCPIPStatus	Returns the status of the RT-TCP/IP Stack.
RtfwStartTCPIPStack	Starts the RT-TCP/IP Stack.
RtfwStopTCPIPStack	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
RtfwFreeDeviceMemory	Frees the memory associated with the array of structure RTFW_DEVICEEX pointed to by parameter pRTX64Devices.
RtfwGetRTX64Devices	Enumerates RTX64-owned devices.
RtfwGetRTX64DevicesEx	Retrieves the properties of all devices owned by RTX64.

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.

Scheduled Processes

Function	Description
RtfwCreateScheduledProcess	Creates a new scheduled process to start with the Real-time Subsystem.
RtfwDeleteAllScheduledProcesses	Deletes all scheduled processes.
RtfwDeleteScheduledProcessByID	Deletes the scheduled process specified by an identifier.
RtfwGetCurrentScheduledProcessCount	Retrieves the total number of scheduled processes.
RtfwGetPIDByScheduledID	Retrieves the last known PID of a scheduled process that is either currently running or has run in the past.
RtfwModifyScheduledProcess	Modifies an existing scheduled process.

Configuring the RTX64 Real-Time Output Console

Function	Description
RtfwGetConsoleConfiguration	Retrieves the configuration of the RTX64 real-time output console. This function is deprecated and will be removed from a future release. Use RtfwGetConsoleConfigurationEx.
RtfwSetConsoleConfiguration	Configures the RTX64 real-time output console. This function is deprecated and will be removed from a future release. Use RtfwSetConsoleConfigurationEx.
RtfwGetConsoleConfigurationEx	Retrieves the configuration of the RTX64 real-time output console.
RtfwSetConsoleConfigurationEx	Configures the RTX64 real-time output console.

Configuring Remote Debugging

Function	Description
RtfwGetRemoteDebuggerConfiguration	Retrieves the RTX64 remote debugger configuration.
RtfwSetRemoteDebuggerConfiguration	Sets the RTX64 remote debugger configuration.