FC_CheckProgramIdent - General Information

Overview

Type:	Function
Available as of:	SystemInterface_1.32.6.0
Versions:	Current version

Task

Before loading a memory image (retain image), you have to check if it fits the application.

Description

The function reads the ProgramIdent of the memory image from the specified file and compares it with the ProgramIdent of the application that is currently located in the memory.

NOTE: The typical runtime of the function on a controller is 50 ms if the retain data file is located on the 'ide0:' drive.

Interface

Input	Data type	Description
i_sRetainImageFileName	STRING[80]	Name of the file whose ProgramIdent is to be compared with the ProgramIdent of the program currently located in the main memory. The file name automatically receives the extension .ret. The file may be located in any existing directory of the controller. The file name must not include any special characters or wildcards.

Return Value

Data type	Description
DINT	0: The ProgramIdent of the program and memory image match. -1: The ProgramIdent could not be compared because an invalid file name was transferred. The file name contains special characters ":", "\" or "/" and wildcards "*" or "?". -2: The additional information could not be read because the specified directory does not exist. -3: The ProgramIdent could not be compared because the specified file name does not exist. -4: The ProgramIdent of the program and memory image do not match. -5: The ProgramIdent could not be compared because the specified file is not a memory image file of a retain memory. -6: The ProgramIdent could not be compared because the specified file does not contain a memory image of the retain memory.

Data type

Description

DINT

0: The ProgramIdent of the program and memory image match.

-1: The ProgramIdent could not be compared because an invalid file name was transferred. The file name contains special characters ":", "\" or "/" and wildcards "*" or "?".

-2: The additional information could not be read because the specified directory does not exist.

-3: The ProgramIdent could not be compared because the specified file name does not exist.

-4: The ProgramIdent of the program and memory image do not match.

-5: The ProgramIdent could not be compared because the specified file is not a memory image file of a retain memory.

-6: The ProgramIdent could not be compared because the specified file does not contain a memory image of the retain memory.

Examples

diResult := FC_CheckProgramIdent(‚karton');

The ProgramIdent of the application is compared with the ProgramIdent stored in the file 'karton.ret'. The file 'karton.ret' is located on the default device 'ide0:'.

diResult := FC_CheckProgramIdent(‚ide0:\retain\plister');

The ProgramIdent of the application is compared with the ProgramIdent stored in the file 'plister.ret'. The file 'plister.ret' is located in the directory ‚retain’ on the default device 'ide0:'

diResult := FC_CheckProgramIdent('remote:ide0:\etikett');

The ProgramIdent of the application is compared with the ProgramIdent stored in the file 'etikett.ret'. The file 'etikettt.ret' is located on the remote device 'remote:' in the drive 'ide0:'.