api_docs_2023-6/FileMode_8hpp_source.html

//

//  Copyright PHOENIX CONTACT Electronics GmbH

//

#pragma once

#include "Arp/System/Core/Arp.h"

#include "Arp/System/Core/Enum.hxx"


namespace Arp { namespace System { namespace Commons { namespace Io

{


enum class FileMode

{

    None = 0,

    CreateNew = 1,

    Create = 2,

    Open = 3,

    OpenOrCreate = 4,

    Truncate = 5,

    Append = 6

};


// global stream operators of enum FileMode for logging and parsing

ARP_CXX_SYMBOL_EXPORT std::ostream& operator<<(std::ostream& os, FileMode value);

ARP_CXX_SYMBOL_EXPORT std::istream& operator>>(std::istream& is, FileMode& value);


}}}} // end of namespace Arp::System::Commons::Io

Arp.h

Arp::System::Acf::ComponentCategory::System
@ System
System components used by the System, Device, Plc or Io domains.

Arp::System::Commons::Io::FileMode
FileMode
Contains constants for specifying how the OS should open a file.
Definition: FileMode.hpp:24

Arp::System::Commons::Io::FileMode::CreateNew
@ CreateNew
Creates a new file. An exception is raised if the file already exists.

Arp::System::Commons::Io::FileMode::OpenOrCreate
@ OpenOrCreate
Opens the file for update, if it exists. Otherwise, creates a new file.

Arp::System::Commons::Io::FileMode::Append
@ Append
Opens the file if it exists and seeks to the end. Otherwise, creates a new file.

Arp::System::Commons::Io::FileMode::Create
@ Create
Creates a new file. If the file already exists, it is overwritten.

Arp::System::Commons::Io::FileMode::Truncate
@ Truncate
Opens an existing file. Once opened, the file is truncated so that its size is zero bytes....

Arp::System::Commons::Io::FileMode::Open
@ Open
Opens an existing file. An exception is raised if the file does not exist.

Arp
Root namespace for the PLCnext API