api_docs_2025-0/File_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

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

#include <vector>


namespace Arp { namespace System { namespace Commons { namespace Io

{


class File

{

public: // construction/destruction

    File(void) = delete;


public: // static operations

    static bool Exists(const String& path);

    static void Delete(const String& path);

    static void Delete(const String& path, bool sync);

    static void Copy(const String& sourcePath, const String& destinationPath, bool createDirectory = true, bool overwrite = true);

    static void Copy(const String& sourcePath, const String& destinationPath, bool createDirectory, bool overwrite, bool sync);

    static void Move(const String& sourcePath, const String& destinationPath, bool createDirectory = true, bool overwrite = true);

    static void Move(const String& sourcePath, const String& destinationPath, bool createDirectory, bool overwrite, bool sync);

    static std::vector<byte>  ReadAll(const String& path);

    static void WriteAll(const String& path, const std::vector<byte>& data);

    static void WriteAll(const String& path, const std::vector<byte>& data, bool sync);

    static void SyncAll(void);

    static void Sync(const String& path);

};


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

Arp.h

Arp::Base::Core::String
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39

Arp::System::Commons::Io::File
API to manage and manipulate single files.
Definition: File.hpp:15

Arp::System::Commons::Io::File::Copy
static void Copy(const String &sourcePath, const String &destinationPath, bool createDirectory=true, bool overwrite=true)
Copies a file from source path to destination path. After successful operation, the synchronization o...
Definition: File.cpp:89

Arp::System::Commons::Io::File::ReadAll
static std::vector< byte > ReadAll(const String &path)
Reads data from file and returns it as byte array.
Definition: File.cpp:229

Arp::System::Commons::Io::File::Exists
static bool Exists(const String &path)
Checks for existence of a file.
Definition: File.cpp:23

Arp::System::Commons::Io::File::Sync
static void Sync(const String &path)
Force file system synchronization for the given file.
Definition: File.cpp:295

Arp::System::Commons::Io::File::Move
static void Move(const String &sourcePath, const String &destinationPath, bool createDirectory=true, bool overwrite=true)
Moves a file from source path to destination path. After successful operation, the synchronization of...
Definition: File.cpp:159

Arp::System::Commons::Io::File::Delete
static void Delete(const String &path)
Deletes the file from the filesystem. After successful operation, the synchronization of the file sys...
Definition: File.cpp:42

Arp::System::Commons::Io::File::SyncAll
static void SyncAll(void)
Force global file system synchronization.
Definition: File.cpp:287

Arp::System::Commons::Io::File::WriteAll
static void WriteAll(const String &path, const std::vector< byte > &data)
Writes the data in data into file identified by path. After successful operation, the synchronization...
Definition: File.cpp:259

Arp
Root namespace for the PLCnext API