Arp::Plc::Retain::Services Namespace Reference

Namespace for services of the Retain component More...

Classes
class	BackupResult
	Contains the name and error code of the backup. More...
class	IRetainManagerService
	Use this service for the retain backup handling. More...

Enumerations
enum class	BackupError : uint8 {   None = 0 , UnableToWriteFile = 1 , UnableToReadFile = 2 , NoRetainData = 3 ,   CrcFileMismatch = 4 , NoSuchFile = 5 , LayoutMismatch = 6 , InvalidVersion = 7 ,   InvalidFile = 8 , Unspecified = 255 }
	Possible error codes for retain rsc services. More...

Functions
ARP_EXPORT std::ostream &	operator<< (std::ostream &os, BackupError value)
ARP_EXPORT std::istream &	operator>> (std::istream &is, BackupError &value)

Detailed Description

Namespace for services of the Retain component

Enumeration Type Documentation

BackupError

enum class Arp::Plc::Retain::Services::BackupError : uint8

strong

Possible error codes for retain rsc services.

Enumerator
None	Function call succeeded.
UnableToWriteFile	Error when writing the backup file, e.g. no permission or out of memory.
UnableToReadFile	Error when reading the backup file, e.g. no permission.
NoRetainData	No retain data exists to create a backup.
CrcFileMismatch	Crc mismatch while reading a the backup file.
NoSuchFile	No backup file exists.
LayoutMismatch	The backup data layout does not match the project.
InvalidVersion	The backup version is not valid / supported.
InvalidFile	The backup file is not valid.
Unspecified	Unspecified error. See log file for more information.