FC_RetainImageSave - Allgemeine Informationen

Übersicht

Typ

Funktion

Verfügbar ab

SystemInterface_1.32.6.0

Versionen:

Aktuelle Version

Aufgabe

Den Inhalt des Retain-Speichers (nicht flüchtigen Speichers) in einer Datei speichern.

Beschreibung

Die Funktion speichert den gesamten Inhalt des Retainspeichers in die angegebene Datei ab. Da die Adressierung und Zuweisung der Variablen im Retainspeicher nicht vorhergesagt werden kann, wird der gesamte Retainspeicher gespeichert. Zusätzlich können eigene Informationen in der Datei gespeichert werden.

Wenn eine Datei mit demselben Namen und Speicherort vorhanden ist, wird diese Datei überschrieben.

HINWEIS: Während die Funktion ausgeführt wird, können die Retaindaten nicht geändert werden. Ansonsten kann das spätere Laden dieser Daten zu inkonsistenten Retaindaten führen. Es muss sichergestellt werden, dass während des Ausführens der Funktion FC_RetainImageSave() kein Zugriff auf die Retaindaten erfolgt.
HINWEIS: Die typische Laufzeit der Funktion auf einer Steuerung beträgt beim Speichern des Retainspeichers auf das Laufwerk "ide0:" 400 ms.

Schnittstelle

Eingang

Datentyp

Beschreibung

i_sRetainImageFileName

STRING[80]

Name der Datei, in der der Inhalt des Retain-Speichers geladen werden soll.

Der Dateiname erhält automatisch die Endung ".ret". Die Datei kann in einem beliebigen Verzeichnis der Steuerung gespeichert werden. Es sind keine Sonderzeichen oder Platzhalter im Dateinamen erlaubt.

i_sUserInfo

STRING[255]

Informationen, die ebenfalls in der Datei des Speicherabbilds des Retainspeichers gespeichert werden müssen.

Rückgabewert

Datentyp

Beschreibung

DINT

0: Der Retainspeicher wurde erfolgreich gespeichert.

-1: Der Retainspeicher konnte nicht gespeichert werden, da ein ungültiger Dateiname angegeben wurde. Der Dateiname enthält Sonderzeichen ":", "\" oder "/" und Platzhalter "*" oder "?".

-2: Der Retainspeicher konnte nicht gespeichert werden, da das Verzeichnis nicht vorhanden ist, in dem das Speicherabbild gespeichert werden sollte.

-3: Der Retain-Speicher konnte nicht gespeichert werden, da in der Funktion FC_RetainImageSave() ein allgemeiner Fehler erkannt wurde.

Beispiele 

diResult := FC_RetainImageSave('karton', 'Speicherabbild Kartonierer');

Der Retainspeicher wird in die Datei "karton.ret" auf dem Standardgerät "ide0:" abgespeichert. 

diResult := FC_RetainImageSave(‚ide0:\retain\plister' ‚Speicherabild Plister');

Der Retainspeicher wird in die Datei "plister.ret" in dem Verzeichnis "retain" auf dem Standardgerät "ide0:" abgespeichert. 

diResult := FC_RetainImageSave(‚remote:ide0:\etikett' ‚Speicherabbild Etikettierer');

Der Retainspeicher wird in die Datei "etikett.ret" auf dem Laufwerk "ide0:" abgespeichert, das sich auf dem Remote-Gerät "remote:" befindet.