Programmbaustein als Dokument exportieren - TIAPortal

TIA Portal Openness: API für die Automatisierung von Engineering-Workflows

ft:publication_title
TIA Portal Openness: API für die Automatisierung von Engineering-Workflows
Product
TIAPortal
Version
V20
Publication date
01/2025
Language
de-DE
Programmbaustein als Dokument exportieren

Voraussetzung

Einleitung

Sie können mit TIA Portal Openness Programmbausteine und DB-Komponenten als Dokument exportieren und importieren. Sie können auf die Komponenten Ihres TIA Portal-Projekts mit TIA Portal Openness zugreifen. Wenn Sie Dateien im Format SIMATIC SD verwenden, können Sie den Programmcode der Steuerung direkt lesen. Informationen zum Importieren von Programmbausteinen aus einem Dokument finden Sie unter Programmbaustein aus Dokument importieren.

Die Methode ExportAsDocument() wird verwendet, um Programmbausteine und DBs als Dokument zu exportieren. Die Methode ermöglicht Ihnen, das Zielverzeichnis und den Basisdateipfad ohne Erweiterung anzugeben, um ein Element als Dokument zu exportieren. Das Ergebnis des Exportvorgangs ist im Objekt DocumentExportResult verfügbar. Es stellt Details über die exportierten Dateien, den Status des Exportvorgangs und alle während des Prozesses protokollierten Meldungen bereit.

Parameter

Die Methode ExportAsDocument() akzeptiert bei Verwendung von TIA Portal Openness folgende Parameter:

Parametername

Datentyp

Beschreibung

directoryInfo

System.IO.DirectoryInfo

Gibt das Verzeichnis an, in dem die Dokumente gespeichert werden. Das Verzeichnis muss vorhanden sein, bevor diese Methode aufgerufen wird.

fileNameWithoutExtension

String

Gibt den Basisdateinamen für die exportierten Dokumente an.

Rückgabetyp

Die Methode ExportAsDocument() gibt das Objekt DocumentExportResult zurück, das verwendet wird, um das Ergebnis des exportierten Dokuments zu speichern. Der Rückgabetyp DocumentExportResult umfasst folgende Komponenten:

Name

Datentyp

Beschreibung

ImportedPlcBlocks

Siemens.Engineering.SW.PlcBlockAssociation

Liste von Programmbausteinen, die exportiert werden.

Messages

DocumentResultMessageComposition

Gibt die Meldungen zurück, die während des Exportvorgangs protokolliert werden.

Parent

IEngineeringObject

Übergeordnetes EOM-Element dieses Objekts.

State

DocumentResultState

Status des Dokumentenimportvorgangs.

Programmcode

Um einen PLC-Baustein als Dokument zu exportieren, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

private void ExportPLCBlockAsDocument(PlcSoftware plcSoftware)

{

    DocumentExportResult documentExportResult = plcSoftware.BlockGroup.Blocks[0].

    ExportAsDocuments(new DirectoryInfo(@"D:\Project\Exported Files"), "LAD_Block");

    DocumentResultState documentResultState = documentExportResult.State;

    IEnumerable<FileInfo> exportedDocuments = documentExportResult.ExportedDocuments;

    DocumentResultMessageComposition documentMessages- = documentExportResult.Messages;

    // DocumentResultMessageComposition contains list of DocumentResultMessage.

    DocumentResultMessage documentResultMessage = documentExportResult.Messages[0].Message;

}