System_close block

Short summary

Name

System_close

→POU type

→function

Category

more system blocks, blocks for calling system functions, block with internal error diagnostic

Graphical interface

images/download/thumbnails/414780366/System_close-version-1-modificationdate-1534499662218-api-v2.png

Available since

  • version 1.13.0 (for logi.CAD 3) and version 2.3.901 of the →runtime system – initial variant

    images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for →Raspberry Pi only.

  • version 1.54.0 (for logi.CAD 3) and version 3.0.9 of the →runtime system – enhancement: additional output rcimages/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for the built-in PLC

    and for Raspberry Pi only.

  • version 1.109.0 (for logi.CAD 3) and version 3.19.0 of the →runtime system
    images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for the built-in PLC

    , for Raspberry Pi
    and when using the platform LinuxX86 only.

  • version 2.0.4 (for library System) and version 3.23.0 of the →runtime system
    images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for the built-in PLC and when using the platform LinuxX86 .

    Moreover, the block is supported when using the following target systems: Raspberry Pi, →phyBOARD-Regor, →phyBOARD-Wega, →µMIC.200

Functionality

The block closes a file descriptor so that it cannot be used anymore.

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

→Data type

Description

Inputs:

fd

DINT

file descriptor to close

Outputs:

rc

DINT

return code:

  • 0 = no error

  • -3 = failed system call

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
Linux standard values (e.g. valid for Raspberry Pi): see http://www-numi.fnal.gov/offline_software/srt_public_context/WebDocs/Errors/unix_system_errors.html

Return value:

DINT

returns the return code of the close 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.