FileSize

PLCopen motion icon

Function Block - Gets the size of 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, read the size of a file.
Path	STRING	No range	N/A	No default	The path to the file.

Input

Data Type

See Data Types.

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

On the rising edge, read the size of a file.

Path

STRING

No range

N/A

No default

The path to 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.
Size	DINT	-1 to 2147483647	N/A	The size of the file in bytes.

FBD Language Example

Not available.

FFLD Language Example

Not available.

IL Language Example

Not available.

ST Language Example

(* FileSize example *)
CASE StepCounter OF
0:
   Inst_FileSize(TRUE, 'Test.txt');
   StepCounter := StepCounter + 1;
1:
   Inst_FileSize(TRUE, 'Test.txt');
   IF Inst_FileSize.Done THEN
      TestFileSize := Inst_FileSize.Size;
      Inst_FileSize(FALSE, '');
      StepCounter := StepCounter + 1;
   END_IF;
END_CASE;