RtfwIsComponentInstalled

RtfwIsComponentInstalled returns the install status and specific version information of the specified product component.

Syntax

Copy 
BOOL RtfwIsComponentInstalled(
  [in]               LPTSTR pComponentName,
  [out, optional]    RT_COMPONENT_INFO * pComponentInfo
);

Parameters

[in] pComponentName

A pointer to a null-terminated string specifying the component code to query:

Component name Description

ANALYZER

wRTOS Analyzer can retrieve operating system information, wRTOS installation information, Visual Studio information, boot.ini/bcdedit information, processor information, BIOS information, memory information and plug-and-play device information, and can optionally be used to gather system latency information. The tool can output this information to a text file.

RLY

The wRTOS Network Relay component creates a communication channel between Windows and RTSS, allowing Windows applications to send and receive Ethernet frames through NICs owned by wRTOS.

CONFIGURATION

The wRTOS ESI Configuration component allows you to configure and tune E-CAT devices.
CPL wRTOS Control Panel allows you to start and stop system components.

DOC

wRTOS product documentation, including Release Notes, component and feature descriptions, reference documentation, architectural overviews, and step-by-step instructions for using functionality. The SDK Help includes API reference documentation, sample projects, and information on developing and debugging real-time applications.
ECAT

The wRTOS E-CAT MainDevice exposes Windows and real-time interfaces that offer support for CANopen over EtherCAT and simplifies configuration of EtherCAT networks with its unique plug-and-play approach.

Optional add-on feature packages:

  • High Speed Timer
  • Multiple MainDevice
  • Hot Connect
  • Cable Redundancy

ESI_IMPORT

The wRTOS E-CAT ESI Import tool allows you to import EtherCAT SubDevice Information (ESI) files for your EtherCAT hardware devices and save the ESI data into the E-CAT component database.

LATENCY_VIEW

wRTOS Latency View displays a visual latency comparison between Windows and wRTOS cores.

MESSAGE_VIEWER

wRTOS Message Viewer allows you to view debug/log messages generated during the execution of real-time applications.

MONITOR

wRTOS Monitor allows you to trace the behavior of your real-time applications by recording significant events that occur during execution of those applications. The events are written to disk, where they are grouped into sessions. Each session corresponds to a single folder with one or more files containing events generated during that session.
NL2 The wRTOS Network Link Layer (NL2) component provides real-time applications with abstract APIs to access network services at the Layer 2 of the OSI model, independent of the underlying hardware. Using the NL2, you can more easily take advantage of network resources.

REMOTEDBG

The wRTOS Remote Debugging component supports a Host-Target debug connection, where the Visual Studio IDE resides on the host system and the process to be debugged resides on a target system on the local network.

SETTINGS

The wRTOS Settings tool allows you to activate product components, set the wRTOS boot configuration, and configure default behavior for the Real-Time Subsystem (RTSS), real-time applications, networking, fieldbuses, and other features. You can also access other wRTOS tools and resources.

TASK_MANAGER

wRTOS Task Manager allows you to view, start, or end any active real-time or Windows applications linked to wRTOS on your system, whether started by wRTOS Task Manager or RtssRun command line utility.
TCPIP The wRTOS TCP/IP Stack component provides processing and network capability within the RTSS environment. wRTOS provides an API that conforms to a subset of the functions defined in the Windows Sockets 2.0 (Winsock) specification for Windows.
VIRTUAL_NETWORK The wRTOS Virtual Network component provides a virtual point-to-point connection between Windows and wRTOS that emulates a local area network connection between Windows and the Real-time Subsystem with no additional hardware required.
VISION wRTOS Vision GigE Vision provides functionality for using GigE Vision Cameras within the real-time wRTOS environment. Using Vision, you can quickly discover cameras on the network, query different camera configurations, and acquire image data. Through a provided communication library images can be passed between RTSS and Windows. Or a third-party vision library, such as OpenCV, can be layered on top of GigE Vision interface to provide additional image processing functionality within RTSS.

WRTOS

The wRTOS Runtime component, which includes the Real-Time Subsystem (RTSS).

[out, optional] pComponentInfo

A pointer to a structure containing version information and a readable friendly name of the specified component.

Return Value

If the specified component is installed, this function returns TRUE and parameter pComponentInfo, if it is not NULL, will be filled with data. If the specified component is not installed, this function returns FALSE and sets the last error to ERROR_FILE_NOT_FOUND.

Possible error codes:

Error code Meaning

ERROR_FILE_NOT_FOUND

The specified component is not installed.

Requirements

Note: This function is only supported in the Windows environment.

Minimum supported version Header Library

wRTOS 1.0 SDK

RtLicensing.h

RtfwApi.lib

See Also: