ALib C++ Framework
by
Library Version: 2605 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::variables::IniFile::Entry Struct Reference

Description:

An entry in a Section.

Definition at line 125 of file inifile.hpp.

#include <inifile.hpp>

Collaboration diagram for alib::variables::IniFile::Entry:
[legend]

Public Field Index:

String Comments = NULL_STRING
 The entry's comments.
void * Custom = nullptr
int FirstLineNo = -1
int LineNo = -1
 If given, the line number in the source file.
String Name = NULL_STRING
 The entry's name.
String NewValue = NULL_STRING
String RawValue = NULL_STRING
String Value = NULL_STRING
bool WriteBack = false

Field Details:

◆ Comments

String alib::variables::IniFile::Entry::Comments = NULL_STRING

The entry's comments.

Definition at line 127 of file inifile.hpp.

◆ Custom

void* alib::variables::IniFile::Entry::Custom = nullptr

May be used by freely by customers of this class. Initialized with nullptr, but otherwise not touched.

Definition at line 137 of file inifile.hpp.

◆ FirstLineNo

int alib::variables::IniFile::Entry::FirstLineNo = -1

Set by the method ".Read" in case the entry was given more than once.

Definition at line 141 of file inifile.hpp.

◆ LineNo

int alib::variables::IniFile::Entry::LineNo = -1

If given, the line number in the source file.

Definition at line 140 of file inifile.hpp.

◆ Name

String alib::variables::IniFile::Entry::Name = NULL_STRING

The entry's name.

Definition at line 126 of file inifile.hpp.

◆ NewValue

String alib::variables::IniFile::Entry::NewValue = NULL_STRING

If this value is set, RawValue will be ignored on writing.

Definition at line 135 of file inifile.hpp.

◆ RawValue

String alib::variables::IniFile::Entry::RawValue = NULL_STRING

The 'raw' value, which is everything after the variable name, including the equal sign '='.

Definition at line 128 of file inifile.hpp.

◆ Value

String alib::variables::IniFile::Entry::Value = NULL_STRING

The trimmed value. Multiline values are likewise trimmed and backslashes and line feeds are removed '\. This value is to be used for reading a variable's content.

Definition at line 130 of file inifile.hpp.

◆ WriteBack

bool alib::variables::IniFile::Entry::WriteBack = false

If given, a write back indicator was found for this entry.

Definition at line 143 of file inifile.hpp.


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