File Plug-in

<< Click to Display Table of Contents >>

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

File Plug-in

The File plug-in deals with functionality required to retrieve information about and to manipulate files.

 

Function Summary

•CompareFiles

•CopyFile

•DeleteFile

•FileExists

•FileOpenDialog

•GetACL

•GetCertificateData

•GetHash

•GetProperty

•GetTextFileContent

•Unzip

•VerifyZip

 

Function Details

CompareFilesCheckpoint

Binary content comparison of files.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

FileA

formatted string

 
 

The name and path of the first file for the comparison.

 

Example:

C:\Temp\Sample.vbs

FileB

formatted string

The name and path of the second file for the comparison.

 

Example:

C:\Temp\Sample2.vbs

 

CopyFileCheckpoint

Copies a file. If the file targeted by source is not found, the returned result is No, otherwise Yes.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

Source

formatted string

 
 

The name and path of the source file.

 

Example:

C:\Temp\Sample.vbs

Target

formatted string

The target destination (full path with file name).

 

Example:

C:\Windows\Sample2.vbs

 

DeleteFileData Field

Deletes a file of the given name.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

Filename

formatted string
 

The name and path to the file that is to be deleted.

 

Example:
C:\Windows\SampleFile.msi

Delete after reboot

boolean string

optional

default value: false

If set, the file will be deleted after reboot.

•false: The file will be deleted directly.

•true: The file will be deleted after a reboot.

 

finger1

Be aware:

The Delete after Reboot option will only be working if RayQC has been started using administrative rights!

 

 

FileExistsCheckpoint

Checks if a file exists. If the file is not found, the returned result is No, otherwise Yes.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

File

formatted string

 
 

The name and path of the file whose existence has to be verified.

 

Example:

C:\Temp\Sample.vbs

 

FileOpenDialogData Field

Displays a new instance of an open file system dialog.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

FileType

formatted string
 

•1..n filter definitions, separated by a pipe (|)

•Each filter definition consists of "description|pattern"

 

Example:

To filter for text files:

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

To deactivate the filter:

All files (*.*)|*.*

FullFilename

boolean string

optional

default value: true

Options:

•true: Result contains full file path

•false: Result contains file name (without path)

 

 

GetACLData Field

Get a file's access control list.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

File

formatted string

The name and path to the file whose ACL info has to be retrieved.

 

Example:
C:\Windows\SampleFile.ini

 

GetCertificateDataData Field

Reads the subject string from the certificate of a file.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

File

formatted string

The name and path of the file whose certificate info has to be retrieved.

 

Example:
C:\Windows\SampleFile.ini

 

 

GetHashData Field

Returns the hash value for a file.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

File

formatted string
 

The name and path of the file whose hash value has to be calculated.

 

Example:
C:\Windows\SampleFile.ini

Algorithm

formatted string

optional

default value: SHA-1

List of available calculation algorithms to select from.
 

Options:

•MD5

•SHA-1

•SHA256

•SHA384

•SHA512

•RIPEMD160

 

GetPropertyData Field

Get the value for the chosen file property.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

File

formatted string
 

The name and path of the file whose property value has to be retrieved.

 

Example:
C:\Windows\SampleFile.ini

Property

formatted string

 

List of available properties to select from.
 

Options:

•Version: the file version

•Size: the file size in bytes

 

GetTextFileContentData Field

Gets the content of a text file including white characters.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

Text file path

string
 

The name and path of the file whose property value has to be retrieved.

 

Example:
C:\Windows\example.txt

 

UnzipData Field

Extracts files from a ZIP archive.

Usable in combination with elements of type Data Field.

 

Input parameters

Name

Type

Description & Examples

File

formatted string
 

The name and path of the .zip file.

 

Example:
C:\Windows\SampleContainer.zip

Cleanup

boolean string

optional

default value: true

The path to the folder that contains the unzipped files is determined by the SHA-1 hash value of the .zip container.

 

Options:

•enabled: If the calculated unzip target folder already exists, it will be reused.

•disabled: The calculated unzip target folder will be cleared if it already exists, and populated with the current .zip content.

 

 

VerifyZipCheckpoint

Validates the integrity of a ZIP file. If needed, this function processes a full archive extraction for checking.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

File

formatted string
 

The name and path of the .zip file.

 

Example:
C:\Windows\SampleContainer.zip

Extract Check

boolean string

optional

default value: false

Determines whether or not RayQC extracts the files if the requested .zip.

 

Options:

•enabled: Files are extracted to check the archive structure.

•disabled: Files are not extracted.