LabWindows/CVI Real-Time Module

FindAllRTSystemsOnSubnet

  • Updated2023-02-21
  • 2 minute(s) read

int FindAllRTSystemsOnSubnet (RTSystemInfoPtr **systems, int *numSystems);

Purpose

Discovers all RT systems present on the local subnet and returns an array of system information pointers (RTSystemInfoPtr) containing information about each target. FindAllRTSystemsOnSubnet finds only systems that are booted and running, though the systems do not need to have IP settings configured or have any software installed.

Windows This function is supported only on Windows.

Parameters

Output
Name Type Description
systems RTSystemInfoPtr * Output parameter that receives a null-terminated array of system information pointers (RTSystemInfoPtr). FindAllRTSystemsOnSubnet dynamically allocates a RTSystemInfoPtr for each system that is found and the array in which to store the structure pointers. The returned array is numSystems + 1 long, with the last item being a null pointer.

This function allocates new memory each time you call it. If you call this function multiple times, you must explicitly free the previously returned array and structures between each call. Do not attempt to reuse previously allocated arrays or structures by passing them back in. You must call DisposeRTSystemInfo on each RTSystemInfoPtr in the returned array. You must also free the array itself by calling FreeRTUtilMemory.
numSystems int A pointer to a variable that receives the number of systems found. This value is the number of system information pointers (RTSystemInfoPtr) returned in the systems parameter.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. Unless otherwise stated, zero indicates successful execution and a negative number indicates that an error occurred.

You can call the GetRTUtilErrorString function to obtain a message that describes the error.

Additional Information

Library: Real-Time Utility Library

Include file: rtutil.h

LabWindows/CVI compatibility: LabWindows/CVI 8.5 and later

Examples

Refer to the following examples that use the FindAllRTSystemsOnSubnet function:

  • realtime\RTConfig\RTConfig.cws

    Open example
  • realtime\RTSystemImaging\RTSystemImaging.cws

    Open example

Log in to get a better experience