|
Type
| Function block |
|
Description
| Closes a file in the parameterization memory that has been opened using the FILE_OPEN_2 function block.Assign the valid handle of an open file to the
HANDLE input. As soon as the REQ input is set to TRUE, the inputs are validated. The REQ input must remain set to TRUE, until the file close operation is completed (regardless of whether the operation succeeded or failed). The BUSY output is TRUE while the operation is being executed asynchronously on a Service Thread. Execution of the function block is complete when the DONE output is set to TRUE.If an error occurred during execution, ERROR is set to TRUE, and the error code can be read from the STATUS output. |
|
Notes
|
- The status of the outputs DONE, BUSY, ERROR, and STATUS is maintained as long as REQ is TRUE.Do not reset the REQ input until the FB is finished by setting the DONE state. Resetting the REQ input will result in resetting the outputs to their default values.
- When the function block is used as global function block, it is not thread-safe. In this case, make sure to prevent concurrent calls (e.g., by using the MUTEX function block).
- Function blocks have to be instantiated. The instance name of the function block has to be declared in the 'Variables' table of the POU where the FB is going to be used. The instance name must be unique within the POU.
|
|
Parameters
| Inputs
REQ
| Data type: | BOOL |
| Description: | As soon as the input is set to TRUE, the inputs are validated. Must remain set to TRUE until the file operation is complete. Once the operation is fully complete, the input must be set to FALSE. Subsequently, the outputs are reset to their default values. |
HANDLE
| Data type: | UINT |
| Description: | File handle of the file to be closed. |
Outputs
DONE
| Data type: | BOOL |
| Description: | Set to TRUE when the operation has been completed successfully. |
BUSY
| Data type: | BOOL |
| Description: |
| 0 | No operation executed on Service Thread. |
| 1 | The operation is currently being executed asynchronously on Service Thread. |
|
ERROR
| Data type: | BOOL |
| Description: |
| 0 | No error occurred while executing the operation. |
| 1 | An error occurred while executing the operation. The error code can be read from the STATUS output. |
|
STATUS
| Data type: | FILE_OPERATION_STATUS |
| Description: | Indicates the status of the file operation:
| 0 | No errors during execution of the file operation. |
| 1 | The execution of the file operation has failed. |
| 12 | An invalid file handle was specified. |
|
|