PeanutButter.INI.IParsedLine Interface Reference

Represents a parsed data line. More...

Properties
string	Key [get]
	Key for this line.
string	Value [get]
	Value for this line.
string	Comment [get]
	Comment for this line.
bool	ContainedEscapedEntities [get]
	Helper flag: did the value originally contain escaped entities?

Detailed Description

Represents a parsed data line.

Property Documentation

Comment

string PeanutButter.INI.IParsedLine.Comment

get

Comment for this line.

• must include any whitespace surrounding the comment to insure that rewrite of the file doesn't incur unnecessary changes
• may be the whole line: then ensure that the Key is empty

ContainedEscapedEntities

bool PeanutButter.INI.IParsedLine.ContainedEscapedEntities

get

Helper flag: did the value originally contain escaped entities?

• used on rewrite to determine if entities should be re-escaped when in best-effort mode

Key

string PeanutButter.INI.IParsedLine.Key

get

Key for this line.

• will be a section name if this is a section line
• can be empty if this is a pure comment line
• should never be null

Value

string PeanutButter.INI.IParsedLine.Value

get

Value for this line.

• may be null, eg for the case where a key is specified on a line without an =

---

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

• source/INI/PeanutButter.INI/ILineParser.cs