PLCnext API Documentation  22.9.0.33
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::System::Commons::Services::Io::FileSystemEntry Class Reference

This struct is used by file operations to reading of the file system entries. More...

#include <FileSystemEntry.hpp>

Inheritance diagram for Arp::System::Commons::Services::Io::FileSystemEntry:
Inheritance graph

Public Member Functions

void Serialize (RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor More...
 

Static Public Member Functions

static constexpr size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Public Attributes

RscString< 512 > Path
 The path of the file system entry (file or directory) More...
 
boolean IsFile = false
 The specified path ia a file. More...
 
boolean IsDirectory = false
 The specified path is a directory. More...
 

Detailed Description

This struct is used by file operations to reading of the file system entries.

Arp.System.Commons.Services.Io.IDirectoryService.EnumerateFileSystemEntries

Member Function Documentation

◆ Deserialize()

void Arp::System::Commons::Services::Io::FileSystemEntry::Deserialize ( RscReader reader)
inlineoverridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ Serialize()

void Arp::System::Commons::Services::Io::FileSystemEntry::Serialize ( RscWriter writer) const
inlineoverridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ IsDirectory

boolean Arp::System::Commons::Services::Io::FileSystemEntry::IsDirectory = false

The specified path is a directory.

◆ IsFile

boolean Arp::System::Commons::Services::Io::FileSystemEntry::IsFile = false

The specified path ia a file.

◆ Path

RscString<512> Arp::System::Commons::Services::Io::FileSystemEntry::Path

The path of the file system entry (file or directory)


The documentation for this class was generated from the following file: