/
ExportConnections

Documentation Home Page ◇ RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

ExportConnections

Group

Utilities

Description

Export connections (excluding datalogger connections) into CSV format

The generated file is not supposed to be modified manually to make it work with the ImportConnections API. The file includes the following columns:

  • Connection Type: enum [model ↔︎ IO; model ↔︎ panel]

  • Datapoint 1: Primary ID

  • Datapoint 1: Secondary ID

  • Datapoint 1: Type

  • Datapoint 2: Primary ID

  • Datapoint 2: Secondary ID

  • Datapoint 2: Type

For model datapoints, the Primary ID corresponds to their alias. However, in projects using the new I/O interfaces (mandatory from version 2025.1), this alias is left empty. The Secondary ID refers to their paths.

For IO datapoints, primary ID corresponds to their UI paths where secondary ID may contain GUID in paths.

Required Control

None

Usage

RtlabApi.ExportConnections(filename, overwrite)

Input

  • filename : Optional argument. Save into 'C:/OPAL-RT/RT-LAB/vX/connections.csv' file per default. 

  • overwrite : Optional argument. False per default. Allow to overwrite the csv file if existing.

Output

None

Exception

  • ENOMEM: Memory allocation error.

  • EIO: Error sending the request or receiving the reply.

  • EBADF: Project not specified by previous OpenProject

Examples

None

Related Items

ImportConnections

Modules

import RtlabApi