Configure and Control (RTFW) Functions

The RTFW library functions are grouped below:

Configuring the Subsystem
Configuring the Network
Controlling or Getting Information on Product Components
Devices
Monitoring
Scheduled Processes
Configuring the wRTOS Real-Time Output Console
Configuring Remote Debugging
Configuring the E-CAT Component Instance

Note: RTFW libraries can only be used in Windows applications.

Configuring the Subsystem

Function	Description
RtfwGetSubsystemConfiguration	Returns the core wRTOS Subsystem configuration. See structure RTFW_SUBSYSTEM_CONFIGURATION. Other Subsystem configuration parameters can be obtained using other functions in this library.
RtfwSetSubsystemConfiguration	Modifies the core wRTOS 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 wRTOS Subsystem
RtfwSetProcessorConfiguration	Configures the processor configuration of the wRTOS Subsystem.
RtfwSetDefaultIdealProcessor	Sets the default processor where new processes will be executed by default.
RtfwGetDefaultIdealProcessor	Retrieves the default processor where new processes will be executed by default.
RtfwGetEnabledProcessors	Returns the total number of processors that are enabled on the system.
RtfwGetRtssProcessorsActual	Returns the actual number of processors being used by the wRTOS Subsystem.
RtfwGetExceptionHandling	Returns the current exception handling configuration of the wRTOS Subsystem.
RtfwSetExceptionHandling	Sets the exception handling configuration of the wRTOS Subsystem.
RtfwGetLocalMemoryConfiguration	Returns the Local Memory pool configuration for the wRTOS Subsystem.
RtfwIsComponentInstalled	Returns the install status and specific version information of the specified product component.
RtfwGetLicenseStatus	Returns whether the specified version of a product code has a valid license.
RtfwSetLocalMemoryConfiguration	Sets the Local Memory pool configuration for the wRTOS Subsystem.
RtfwGetPriorityInversionProtocol	Returns the wRTOS Subsystem priority inversion protocol.
RtfwSetPriorityInversionProtocol	Sets the wRTOS Subsystem priority inversion protocol.
RtfwGetSearchPath	Returns the list of directories to be searched by the wRTOS 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 wRTOS Subsystem when loading an RTDLL or launching an RTSS application without specifying an absolute pathname to the RTDLL or RTSS file.
RtfwGetWatchdogConfiguration	Returns the wRTOS Subsystem watchdog timer configuration.
RtfwSetWatchdogConfiguration	Configures the wRTOS 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 the wRTOS Subsystem disables Windows idle detection power optimization while the wRTOS Subsystem is running.
RtfwSetWindowsIdleDetection	Configures whether the wRTOS Subsystem disables Windows idle detection power optimization while the wRTOS Subsystem is running.

Configuring the Network

Network Link Layer (NL2)

Function	Description
Rtfwnl2CreateInterface	Creates a new wRTOS network interface to be used by the Network Link Layer (NL2).
Rtfwnl2DeleteInterface	Deletes a Network Link Layer (NL2) interface.
Rtfwnl2EnableInterface	Enables or disables a Network Link Layer (NL2) interface.
Rtfwnl2GetAllInterfaces	Returns the configurations of all Network Link Layer (NL2) interfaces.
Rtfwnl2GetClientProcessIDs	Returns the IDs for all Network Link Layer (NL2) client processes.
Rtfwnl2GetConfiguration	Returns the configuration of the Network Link Layer (NL2).
Rtfwnl2GetInterface	Returns the configuration of a Network Link Layer (NL2) interface associated with a given name.
Rtfwnl2GetVerbosity	Returns whether verbosity is enabled or disabled for the Network Link Layer (NL2).
Rtfwnl2RenameInterface	Renames a Network Link Layer (NL2) interface.
Rtfwnl2SetConfiguration	Sets the configuration of the Network Link Layer (NL2).
Rtfwnl2SetInterface	Sets the configuration of a Network Link Layer (NL2) interface.
Rtfwnl2SetVerbosity	Enables or disables verbosity for the Network Link Layer (NL2).

Network Relay

Function	Description
RtfwrlyEnableInterface	Enables or disables Network Relay functionality in a network interface.
RtfwrlyGetAllInterfaces	Returns the configurations of all Network Relay interfaces.
RtfwrlyGetConfiguration	Returns the Network Relay configuration.
RtfwrlyGetInterfaceSettings	Returns a Network Relay interface configuration associated with a given name.
RtfwrlyGetVerbosity	Returns whether verbosity is enabled or disabled for the Network Relay component.
RtfwrlySetConfiguration	Sets the Network Relay configuration.
RtfwrlySetInterfaceSettings	Sets the configuration of a Network Relay interface.
RtfwrlySetVerbosity	Enables or disables verbosity for the Network Relay component.

TCP/IP Stack

Function	Description
RtfwtcpipEnableInterface	Enables or disables TCP/IP functionality for a specified network interface.
RtfwtcpipGetAllInterfaces	Enumerates all Network Link Layer (NL2) interfaces that have TCP/IP settings.
RtfwtcpipGetClientProcessIDs	Returns the IDs for all TCP-IP Stack client processes.
RtfwtcpipGetConfiguration	Returns the global configuration of the TCP/IP Stack.
RtfwtcpipGetInterfaceSettings	Returns a TCP/IP Stack interface configuration associated with a given name.
RtfwtcpipGetVerbosity	Returns whether verbosity is enabled or disabled for the TCP/IP Stack.
RtfwtcpipSetConfiguration	Sets the global configuration of the TCP/IP Stack.
RtfwtcpipSetInterfaceSettings	Sets the configuration of a TCP/IP Stack interface.
RtfwtcpipSetVerbosity	Enables or disables verbosity for the TCP/IP Stack.

Controlling or Getting Information on Product Components

Function	Description
RtfwGetSubsystemStatus	Returns the current status of the wRTOS Subsystem.
Rtfwnl2GetComponentStatus	Returns the status of the Network Link Layer (NL2) component.
Rtfwnl2IsComponentLicensed	Returns whether the Network Link Layer (NL2) component has a valid license of the same major version as the currently installed wRTOS Runtime.
Rtfwnl2StartComponent	Starts the Network Link Layer (NL2) component.
Rtfwnl2StopComponent	Stops the Network Link Layer (NL2) component.
RtfwStartSubsystem	Starts the wRTOS Subsystem.
RtfwStopSubsystem	Stops the wRTOS Subsystem and TCP/IP Stack if it is running.
RtfwStopSubsystemForce	Forces the wRTOS Subsystem to stop.
RtfwRestartRequired	Returns whether the wRTOS Subsystem or Windows needs to be restarted after a configuration change has been made using the wRTOS Framework or the wRTOS Settings.
RtfwtcpipGetComponentStatus	Returns the status of the TCP/IP Stack component.
RtfwtcpipIsComponentLicensed	Returns whether the TCP/IP Stack component has a valid license of the same major version as the currently installed wRTOS Runtime.
RtfwtcpipStartComponent	Starts the TCP/IP Stack component.
RtfwtcpipStopComponent	Stops the TCP/IP Stack component.

Devices

Function	Description
RtfwFreeDeviceMemory	Frees the memory associated with the array of structure RTFW_DEVICEEX pointed to by parameter pwRTOSDevices.
RtfwGetwRTOSDevices	Retrieves the properties of all devices owned by wRTOS.

Monitoring

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

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.
RtfwGetScheduledProcess	Retrieves the scheduled process definition at the given startup order.
RtfwModifyScheduledProcess	Modifies an existing scheduled process.

Configuring the wRTOS Real-Time Output Console

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

Configuring Remote Debugging

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

Configuring the E-CAT Component Instance

Function	Description
RtfwecatConfigureInstance	Configures an E-CAT MainDevice instance.
RtfwecatCreateInstance	Defines a new E-CAT MainDevice instance.
RtfwecatDeleteInstance	Deletes an E-CAT MainDevice instance.
RtfwecatGetAllInstances	Gets the configuration of all E-CAT MainDevice instances.
RtfwecatGetInstance	Gets the current E-CAT MainDevice instance configuration.