FC_GetRetainImageInfo - Allgemeine Informationen

Übersicht

Typ	Funktion
Verfügbar ab	SystemInterface_1.32.6.0
Versionen:	Aktuelle Version

Aufgabe

Zusätzliche Informationen lesen, die mit in die Datei eines Speicherabbilds geschrieben werden

Beschreibung

Die Funktion liest die zusätzlichen Informationen in einem Speicherabbild für die angegebene Datei und speichert sie in der übertragenen Struktur. Die zusätzlichen Informationen lauten wie folgt:

oDer Name der Datei

oDas Speicherdatum

oDer Steuerungstyp

oDie Größe des Retainspeichers der Steuerung

oDie Benutzerinformationen

oDer MD5-Hashwert

oDie Größe des Speicherabbilds

HINWEIS: Die typische Laufzeit der Funktion auf einer Steuerung, wenn sich die Retaindatendatei auf dem Laufwerk "ide0:" befindet, beträgt 50 ms.

Schnittstelle

Eingang	Datentyp	Beschreibung
i_sRetainImageFileName	STRING[80]	Name der Datei, deren ProgramIdent mit der ProgramIdent der aktuell im Arbeitsspeicher befindlichen Applikation verglichen werden soll. Der Dateiname erhält automatisch die Endung ".ret". Die Datei kann sich in einem beliebigen Verzeichnis der Steuerung befinden. Es sind keine Sonderzeichen oder Platzhalter im Dateinamen erlaubt.

Ein-/Ausgang	Datentyp	Beschreibung
iq_stInfo	ST_RetainImageInfo	Übergabe von zusätzlichen Informationen (siehe Struktur ST_RetainImageInfo).

Rückgabewert

Datentyp	Beschreibung
DINT	0: Die zusätzlichen Informationen wurden erfolgreich aus der angegebenen Datei gelesen. -1: Die zusätzlichen Informationen konnten nicht gelesen werden, weil der angegebene Dateiname nicht existiert. Der Dateiname enthält Sonderzeichen ":", "\" oder "/" und Platzhalter "*" oder "?". -2: Die zusätzlichen Informationen konnten nicht gelesen werden, weil das angegebene Verzeichnis nicht existiert. -3: Die zusätzlichen Informationen konnten nicht gelesen werden, weil der angegebene Dateiname nicht existiert. -4: Die zusätzlichen Informationen konnten nicht gelesen werden, weil die angegebene Datei keine Datei eines Speicherabbilds eines Retainspeichers ist. -5: Die zusätzlichen Informationen konnten nicht gelesen werden, da in der Funktion FC_GetRetainImageInfo() ein allgemeiner Fehler erkannt wurde.

Datentyp

Beschreibung

DINT

0: Die zusätzlichen Informationen wurden erfolgreich aus der angegebenen Datei gelesen.

-1: Die zusätzlichen Informationen konnten nicht gelesen werden, weil der angegebene Dateiname nicht existiert. Der Dateiname enthält Sonderzeichen ":", "\" oder "/" und Platzhalter "*" oder "?".

-2: Die zusätzlichen Informationen konnten nicht gelesen werden, weil das angegebene Verzeichnis nicht existiert.

-3: Die zusätzlichen Informationen konnten nicht gelesen werden, weil der angegebene Dateiname nicht existiert.

-4: Die zusätzlichen Informationen konnten nicht gelesen werden, weil die angegebene Datei keine Datei eines Speicherabbilds eines Retainspeichers ist.

-5: Die zusätzlichen Informationen konnten nicht gelesen werden, da in der Funktion FC_GetRetainImageInfo() ein allgemeiner Fehler erkannt wurde.

Beispiele

diResult := FC_GetRetainImageInfo(‚karton', stRetainInfo);

Die zusätzlichen Informationen werden aus der Datei "karton.ret" gelesen und in der Struktur "stRetainInfo" des Typs "ST_RetainImageInfo" gespeichert. Die Datei "karton.ret" befindet sich auf dem Standardgerät "ide0:".

diResult := FC_GetRetainImageInfo(‚ide0:\retain\plister', stRetainInfo);

Die zusätzlichen Informationen werden aus der Datei "plister.ret" gelesen und in der Struktur "stRetainInfo" des Typs "ST_RetainImageInfo" gespeichert. Die Datei "plister.ret" befindet sich im Verzeichnis "retain" auf dem Standardgerät "ide0:".

diResult := FC_GetRetainImageInfo(‚remote:ide0:\etikett', stRetainInfo);

Die zusätzlichen Informationen werden aus der Datei "plister.ret" gelesen und in der Struktur "stRetainInfo" des Typs "ST_RetainImageInfo" gespeichert. Die Datei "etikett.ret" befindet sich auf dem Remote-Gerät "remote:" im Laufwerk "ide0:".