FileRename

PLCopen motion icon

Function Block - Renames a file.

Inputs

Input	Data Type	Range	Unit	Default	Description
Execute	BOOL	0, 1	N/A	No default	On the rising edge, request to rename a file.
Path	STRING	N/A	N/A	No default	The path to the file.
NewName	STRING	N/A	User units	No default	The new name of the file.

Outputs

Output	Data Type	Description
Done	BOOL	If TRUE, the command completed successfully.
Error	BOOL	If TRUE, an error has occurred.
ErrorID	DINT	Indicates the error if Error output is TRUE. See the table in File and TCP/IP Function Block ErrorIDs.

Output

Data Type

Range

Unit

Description

Done

BOOL

If TRUE, the command completed successfully.

Error

BOOL

If TRUE, an error has occurred.

ErrorID

DINT

Indicates the error if Error output is TRUE.

See the table in File and TCP/IP Function Block ErrorIDs.

Remarks

Figure 1: FileRename

FBD Language Example

Not available.

FFLD Language Example

Not available.

IL Language Example

Not available.

ST Language Example

(* FileRename example *)
CASE StepCounter OF
0:
   Inst_FileRename(TRUE, 'Original.txt', 'Renamed.txt');
   StepCounter := StepCounter + 1;
1:
   Inst_FileRename(TRUE, 'Original.txt', 'Renamed.txt');
   IF Inst_FileRename.Done THEN
      Inst_FileRename(FALSE, '', '');
      StepCounter := StepCounter + 1;
   END_IF;
END_CASE;