System_delete block
Short summary
Name |
System_delete |
→POU type |
|
Category |
more system blocks, blocks for calling system functions, block with internal error diagnostic |
Graphical interface |
|
Available since |
|
Functionality
The block deletes a file from a given path.
Required expertise
In order to use this block efficiently, you have to be familiar with the functionality of the underlying system call for the operating system used on the PLC.
Inputs, outputs, return value
|
Identifier |
Description |
|
Inputs: |
pathname |
STRING |
the file to be deleted |
Outputs: |
rc |
DINT |
return code:
|
errno |
DINT |
error code returned by the system call Windows standard values (valid for built-in PLC): see https://msdn.microsoft.com/en-us/library/t3ayayh1.aspx |
|
Return value: |
– |
DINT |
returns the return code of the delete system call |
Input EN and output ENO are available when →calling
the block. See "Execution control: EN, ENO" for information on input EN and output ENO.
Internal error diagnostic for block
The block checks the following error cases:
The system service has not been loaded.
The return value of the block is a negative value.
The return code of the function call equates to an error (output rc ≠ value 0).
In such an error case, the output ENO of the block is set to value FALSE (or an equivalent).
Example for usage within ST-editor
At present, there is no example.
When creating your application within the ST-editor, enter a call of a block by typing the text as requested by the syntax or use Content Assist.