SAVE_ALL_NAMED_MEMORY_RETAIN block

Short summary

Name

SAVE_ALL_NAMED_MEMORY_RETAIN

→POU type

→function

Category

IEC-block, MemoryEnh, block with internal error diagnostic

Conform to →IEC-standard

images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/add.svg not defined in IEC-standard

Graphical interface

images/download/thumbnails/429719692/SAVE_ALL_NAMED_MEMORY_RETAIN-version-1-modificationdate-1561969586263-api-v2.png

Available since

version 3.2.2 (for library Standard)
images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for the built-in PLC and the platforms WindowsX86 and LinuxX86 only.

Functionality

The block saves all named →retentive memory areas to persistent storage.

By default, the appropriate file is saved to the subdirectory PLC of the logi.RTS installation directory. If you prefer that a different directory is used, contact your system integrator and ask to change the configuration of the system service.

Return value


Identifier

→Data type

Description

Return value:

USINT

returns result of saving:

  • 16#00: saving succeeded

  • 16#04: named memory not found

  • 16#05: input/output error

  • 16#FF: The service is not available.

Input EN and output ENO are available when →calling the block. See "Execution control: EN, ENO" for information on input EN and output ENO.

See:

Internal error diagnostic for block

The block checks the following error cases:

  • The target system is out of memory.

  • The data type of the variable to which the call has been assigned does not match the data type of the memory area.

  • The RTSSMem system service has not been loaded.

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

Analogous to SAVE_NAMED_MEMORY_RETAIN block .

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.