File Plug-in

<< Click to Display Table of Contents >>

RayQC > 2026.3 > User Guide > Plug-ins > Internal Plug-ins 

File Plug-in

Das File-Plug-in stellt Funktionen zum Abrufen von Informationen über Dateien sowie zur Dateibearbeitung bereit.

 

Funktionsübersicht

CompareFiles

CopyFile

DeleteFile

FileExists

FileOpenDialog

GetACL

GetCertificateData

GetHash

GetProperty

GetTextFileContent

Unzip

VerifyZip

 

Funktionsdetails

CompareFilesCheckpoint

Binärer Inhaltsvergleich von Dateien.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

FileA

Formatierter String

 
 

Name und Pfad der ersten Datei für den Vergleich.

 

Beispiel:

C:\Temp\Sample.vbs

FileB

Formatierter String

Name und Pfad der zweiten Datei für den Vergleich.

 

Beispiel:

C:\Temp\Sample2.vbs

 

CopyFileCheckpoint

Kopiert eine Datei. Wenn die durch die Quelle angegebene Datei nicht gefunden wird, lautet das zurückgegebene Ergebnis Nein, andernfalls Ja.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Quelle

Formatierter String

 
 

Name und Pfad der Quelldatei.

 

Beispiel:

C:\Temp\Sample.vbs

Ziel

Formatierter String

Das Zielverzeichnis (vollständiger Pfad mit Dateiname).

 

Beispiel:

C:\Windows\Sample2.vbs

 

DeleteFileData Field

Löscht eine Datei mit dem angegebenen Namen.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Dateiname

Formatierter String
 

Name und Pfad der zu löschenden Datei.

 

Beispiel:
C:\Windows\SampleFile.msi

Nach Neustart löschen

Boolean-Zeichenfolge

optional

Standardwert: false

Wenn gesetzt, wird die Datei nach einem Neustart gelöscht.

false: Die Datei wird direkt gelöscht.

true: Die Datei wird nach einem Neustart gelöscht.

 

finger1

Achtung:

Die Option Nach Neustart löschen funktioniert nur, wenn RayQC mit Administratorrechten gestartet wurde!

 

 

FileExistsCheckpoint

Prüft, ob eine Datei vorhanden ist. Wenn die Datei nicht gefunden wird, lautet das zurückgegebene Ergebnis Nein, andernfalls Ja.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String

 
 

Name und Pfad der Datei, deren Existenz überprüft werden soll.

 

Beispiel:

C:\Temp\Sample.vbs

 

FileOpenDialogData Field

Zeigt eine neue Instanz eines Öffnen-Dialogs im Dateisystem an.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

FileType

Formatierter String
 

1..n Filterdefinitionen, getrennt durch einen senkrechten Strich (|)

Jede Filterdefinition besteht aus "description|pattern"

 

Beispiel:

Um nach Textdateien zu filtern:

Text files (*.txt)|*.txt|All files (*.*)|*.*

Um den Filter zu deaktivieren:

All files (*.*)|*.*

FullFilename

Boolean-Zeichenfolge

optional

Standardwert: true

Optionen:

true: Ergebnis enthält den vollständigen Dateipfad

false: Ergebnis enthält den Dateinamen (ohne Pfad)

 

 

GetACLData Field

Ruft die Zugriffssteuerungsliste einer Datei ab.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String

Name und Pfad der Datei, deren ACL-Informationen abgerufen werden sollen.

 

Beispiel:
C:\Windows\SampleFile.ini

 

GetCertificateDataData Field

Liest die Betreff-Zeichenfolge aus dem Zertifikat einer Datei.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String

Name und Pfad der Datei, deren Zertifikatsinformationen abgerufen werden sollen.

 

Beispiel:
C:\Windows\SampleFile.ini

 

 

GetHashData Field

Gibt den Hash-Wert einer Datei zurück.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String
 

Name und Pfad der Datei, deren Hash-Wert berechnet werden soll.

 

Beispiel:
C:\Windows\SampleFile.ini

Algorithmus

Formatierter String

optional

Standardwert: SHA-1

Liste der verfügbaren Berechnungsalgorithmen zur Auswahl.
 

Optionen:

MD5

SHA-1

SHA256

SHA384

SHA512

RIPEMD160

 

GetPropertyData Field

Ruft den Wert der ausgewählten Dateieigenschaft ab.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String
 

Name und Pfad der Datei, deren Eigenschaftswert abgerufen werden soll.

 

Beispiel:
C:\Windows\SampleFile.ini

Eigenschaft

Formatierter String

 

Liste der verfügbaren Eigenschaften zur Auswahl.
 

Optionen:

Version: die Dateiversion

Size: die Dateigröße in Bytes

 

GetTextFileContentData Field

Ruft den Inhalt einer Textdatei einschließlich Leerzeichen ab.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Textdateipfad

Zeichenfolge
 

Name und Pfad der Datei, deren Eigenschaftswert abgerufen werden soll.

 

Beispiel:
C:\Windows\example.txt

 

UnzipData Field

Extrahiert Dateien aus einem ZIP-Archiv.

Verwendbar in Kombination mit Elementen vom Typ Data Field.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String
 

Name und Pfad der .zip-Datei.

 

Beispiel:
C:\Windows\SampleContainer.zip

Bereinigung

Boolean-Zeichenfolge

optional

Standardwert: true

Der Pfad zum Ordner, der die entpackten Dateien enthält, wird durch den SHA-1-Hash-Wert des .zip-Containers bestimmt.

 

Optionen:

aktiviert: Wenn der berechnete Entpack-Zielordner bereits vorhanden ist, wird er wiederverwendet.

deaktiviert: Der berechnete Entpack-Zielordner wird geleert, wenn er bereits vorhanden ist, und mit dem aktuellen .zip-Inhalt befüllt.

 

 

VerifyZipCheckpoint

Überprüft die Integrität einer ZIP-Datei. Bei Bedarf führt diese Funktion eine vollständige Archivextraktion zur Prüfung durch.

Verwendbar in Kombination mit Elementen vom Typ Checkpoint.

 

Eingabeparameter

Name

Typ

Beschreibung & Beispiele

Datei

Formatierter String
 

Name und Pfad der .zip-Datei.

 

Beispiel:
C:\Windows\SampleContainer.zip

Extraktionsprüfung

Boolean-Zeichenfolge

optional

Standardwert: false

Legt fest, ob RayQC die Dateien extrahiert, wenn die angeforderte .zip vorhanden ist.

 

Optionen:

aktiviert: Dateien werden extrahiert, um die Archivstruktur zu prüfen.

deaktiviert: Dateien werden nicht extrahiert.