API
Dieses Kapitel dokumentiert alle Klassen und Methoden des TwinCAT-Automation Interface. Die bereitgestellten Schnittstellen können in zwei unterschiedlichen „Ebenen“ unterteilt werden. Ebene 1 beinhaltet die zwei Hauptschnittstellen ITcSysManager und ITcSmTreeItem vom Automation Interface, worüber sämtliche Operationen durchgeführt werden können. Das ITcSmTreeItem-Interface ist ein generisches Interface, welches für alle Elemente innerhalb eines TwinCAT Projektes verwendet werden kann. Auf der Ebene 2 folgen spezialisierte Interfaces, welche erweiterte Funktionen für bestimmte ITcSmTreeItems bereitstellen, welche aber nicht für alle Elemente im TwinCAT Projekt bereitstehen (z. B. ITcPlcPou).
Versionierung von Interfaces
Im Laufe der Jahre wurden die Interfaces vom Automation Interface mit weiteren Funktionalitäten erweitert, um den Zugriff auf neue TwinCAT Funktionalitäten zu bieten. Aus Kompatibilitätsgründen werden die neuen Funktionen in einer neuen Version des Interfaces (z. B. ITcSysManagerX) bereitgestellt. Die neuen Versionen des Interfaces werden dabei um die Zahl X inkrementiert. Bei Beginn eines neuen Automation Interface Projektes ist es sinnvoll, mit der neusten Version des Interfaces zu arbeiten.
Rückgabewerte
Alle Methoden der COM-Interfaces vom Automation Interface geben einen HRESULT zurück. Nachfolgend finden Sie eine Übersicht der HRESULT-Rückgabewerte vom Automation Interface. Innerhalb von .NET werden diese über Exceptions abgebildet.
Name | Typ | Beschreibung |
|---|---|---|
S_OK | HRESULT | Die Funktion wurde erfolgreich ausgeführt. |
E_FAIL | HRESULT | Die Funktion schlägt fehl. |
E_ACCESSDENIED | HRESULT | Das aktuelle Dokument in der System Manager-Instanz ist gesperrt. Dies ist der Fall, wenn mindestens eine Referenz zum System Manager-Objekt oder eines der Tree Items geöffnet ist. |
E_INVALIDARG | HRESULT | Der angegebene Parameter ist ungültig. |
E_POINTER | HRESULT | Die Adresse des Rückgabezeigers ist ungültig. |
TSM_E_ITEMNOTFOUND | HRESULT | Der Pfadname verweist nicht auf ein bestehendes Tree Item. |
TSM_E_INVALIDITEMSUBTYPE | HRESULT | Der angegebene Subtyp ist ungültig. |
Schnittstellen der Ebene 1
Hauptklasse | Beschreibung | Verfügbar seit |
|---|---|---|
Basisklasse für die Erstellung und Parametrisierung einer TwinCAT-Konfiguration. | TwinCAT 2.11 | |
Stellt ein Tree item innerhalb einer TwinCAT-Konfiguration dar. | TwinCAT 2.11 |
Schnittstellen der Ebene 2
Helferklasse | Beschreibung | Verfügbar seit |
|---|---|---|
Definiert Methoden und Eigenschaften für die SPS-Bibliotheksverwaltung. | TwinCAT 3.1 | |
Definiert Methoden und Eigenschaften für den Umgang mit SPS-POUs. | TwinCAT 3.1 | |
Definiert Methoden zum Lesen/Schreiben des Deklarationsbereichs einer SPS-POU. | TwinCAT 3.1 | |
Definiert Methoden zum Lesen/Schreiben des Implementierungsbereichs einer SPS-POU. | TwinCAT 3.1 | |
Definiert Methoden und Eigenschaften bezüglich eines SPS-Projekts, z.B. Einstellung des Projekts als Boot-Projekt. | TwinCAT 3.1 | |
Definiert Methoden, die für den Import/Export von SPS-Projekten in/aus PLCopen XML und für deren Installierung als SPS-Bibliothek benötigt werden. | TwinCAT 3.1 | |
Definiert Methoden und Eigenschaften, um das SPS-Projekt mit einer Task zu verknüpfen. | TwinCAT 3.1 | |
Helferklasse, die eine einzelne SPS-Bibliothek darstellt. | TwinCAT 3.1 | |
Helferklasse, die eine Sammlung von ITcPlcLibRef-Objekten darstellt (und daher Referenzen in einem SPS-Projekt). | TwinCAT 3.1 | |
Helferklasse, die eine Basisklasse für ITcPlcLibrary und ITcPlcPlaceholderRef-Objekte bildet. | TwinCAT 3.1 | |
Helferklasse, die einen einzelnen SPS-Platzhalter darstellt. | TwinCAT 3.1 | |
Helferklasse, die ein einzelnes SPS-Bibliotheks-Repository darstellt. | TwinCAT 3.1 | |
Helferklasse, die eine Sammlung von SPS-Bibliotheks-Repositories darstellt. | TwinCAT 3.1 | |
Schnittstelle zum Import und Export von SPS-Objekten im PLCopen-XML-Format. | TwinCAT 3.1 | |
Schnittstelle für den Online-Zugriff auf eine eingeloggte SPS-Applikation (Login/Logoff, Start/Stop/Reset und Online-Status). | TwinCAT 3.1 | |
Schnittstelle, die die Archiv-Einstellungen eines SPS-Projekts beschreibt (welche Bestandteile in ein Target- bzw. Datei-/E-Mail-Archiv aufgenommen werden). | TwinCAT 3.1 | |
Schnittstelle für den lesenden und schreibenden Zugriff auf den XML-Inhalt eines Objekts. | TwinCAT 3.1 | |
Einstiegsschnittstelle der Benutzerverwaltung zum Anmelden eines Benutzers und Abfragen des aktiven Benutzers. | TwinCAT 3.1 | |
Einstiegspunkt für die registrierten Datentypen des Typsystems (Enumeration, Zugriff sowie Erzeugen und Löschen von Datentypen). | TwinCAT 3.1 | |
Basisschnittstelle für Datentyp- und temporäre Typinstanzen (XML-Serialisierung, Namens-/GUID-Zugriff und Ermittlung abhängiger Datentypen). | TwinCAT 3.1 | |
vtable-basierte COM-Schnittstelle für die Grundeigenschaften einer TwinCAT-Echtzeittask wie Zykluszeit und Priorität. | TwinCAT 3.1 | |
Schnittstelle zum Navigieren in ein verschachteltes Projekt; liefert das Wurzel-TreeItem der inneren Hierarchie. | TwinCAT 3.1 | |
ITcNestedProject | Callback-Schnittstelle, über die der System-Manager ein verschachteltes Projekt über Konfigurationsänderungen informiert. | TwinCAT 3.1 |
Schnittstelle, die ein einzelnes TwinCAT-Projekt mit seinen Dateien in ein Zip-Archiv schreibt. | TwinCAT 3.1 | |
Zentraler Zugriffspunkt auf die im Projekt registrierten TcCOM-Modulinstanzen (Enumeration, Lookup und Online-Parameterzugriff). | TwinCAT 3.1 | |
Basisschnittstelle für eine TcCOM-Modulinstanz mit Parameterzugriff, XML-Import/-Export und Typ-Lookup. | TwinCAT 3.1 | |
Schnittstelle für den Zugriff auf alle geladenen Lizenzdeskriptoren. | TwinCAT 3.1 | |
Kompakter Beziehungseintrag, der eine referenzierte Lizenz-GUID mit einem kontextabhängigen Zahlenwert kombiniert. | TwinCAT 3.1 | |
Schnittstelle, die eine einzelne Lizenzdefinition aus den geladenen Lizenzbeschreibungen beschreibt. | TwinCAT 3.1 | |
Schnittstelle für den Zugriff auf die IEC-Deklarationen von Bibliotheken. | TwinCAT 3.1 | |
COM-Schnittstelle für EtherCAT-Slaves; liefert die Slave-Identifikation und erlaubt das Auflösen einer CoE-Variable. | TwinCAT 3.1 | |
Schnittstelle für den Zugriff auf die Ziel-Plattform-Auswahl des aktuell geladenen TwinCAT-Projekts. | TwinCAT 3.1 | |
Lösungsweiter Archiv-Persistenz-Dienst zum Speichern und Laden ganzer Visual-Studio-Lösungen als Zip-Archiv. | TwinCAT 3.1 | |
Schnittstelle für Import und Export von Archiv-Dateien (*.tszip / *.tnzip) auf Ebene eines TreeItems. | TwinCAT 3.1 |