FileRename

 Function Block - Renames a file.

Inputs

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

Outputs

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

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;

See Also

File Management FileClose FileCopy FileDelete FileEOF FileExists FileOpenA FileOpenR

FileOpenW FileReadBinData FileReadLine FileSeek FileSize FileWriteBinData FileWriteLine