IniFile Class |
IniFileIO Documentation |
Library for handling reading and manipulation of Ini files.
Inheritance Hierarchy
Namespace: IniFileIO
Assembly: IniFileIO (in IniFileIO.dll) Version: 1.4.0.6028 (1.4.0.06028)
Syntax
The IniFile type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | IniFile |
Creates a new object with the read/write path set by fileName.
|
Properties
| Name | Description | |
|---|---|---|
 | FileName |
The file path where the object will be read from and written to.
|
| KeyNameWhitespaceLiteral |
Specifies if the parser includes leading and trailing whitespaces from the source in the Name property.
|
| KeyValueWhitespaceLiteral |
Specifies if the parser includes leading and trailing whitespaces from the source in the Value property.
|
| Sections |
Raw section data stored by the object.
|
Methods
| Name | Description | |
|---|---|---|
| AddKey(String, IniFileKey) |
Adds the key to the specified sectionName.
|
| AddKey(String, String, String, String, Int32) |
Creates a new IniFileKey with the passed in values and adds it to the specified sectionName.
|
| AddSection(IniFileSection) |
Adds the section to the object.
|
| AddSection(String, String, Int32) |
Creates a new IniFileSection with the passed in values.
|
 | CreateFromString |
Creates a new object from the provided text contents.
|
| DeleteKey |
Deletes the key with the name keyName from the specified sectionName.
|
| DeleteSection |
Deletes the section with the specified name.
|
| DeleteSectionKeys |
Deletes all keys from the section with the specified name.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetAllKeys |
Returns the all the keys matching keyName in the specified sectionName.
|
| GetAllKeysWithAName |
Returns the all the keys within sectionName which have a non-empty Name.
|
| GetAllKeysWithAValue |
Returns the all the keys matching keyName in the specified sectionName which have a non-empty Value.
|
| GetAllSections |
Returns the all the sections with the specified name in the object.
|
| GetCommentOutput |
Gets the comment output for writing to a file.
|
| GetHashCode | (Inherited from Object.) |
| GetKey |
Returns the full key within the specified sectionName. If the key does not exist, an empty IniFileKey is returned.
|
| GetKeyComments |
Returns the comments of keyName within the specified sectionName.
|
| GetKeyOrder |
Gets the order of keyName in the specified sectionName.
|
| GetKeyOutput |
Gets the IniFileKey output which is written to the ini file.
|
| GetKeyValue(String, String, String) |
Gets the value of keyName in the specified sectionName.
|
| GetKeyValue(IniFileSection, String, String) |
Gets the value of keyName in the specified section.
|
| GetOutputString(Boolean) |
Returns the current object content as a single string.
|
 | GetOutputString(ListIniFileSection, Boolean, Boolean) |
Helper method which generates the output content.
|
| GetSection |
Returns the section with the specified name. If the section does not exist, an empty IniFileSection is returned.
|
| GetSectionComments |
Returns the comments of the section with the specified name.
|
| GetSectionKeys |
Returns the all the keys in the section with the specified name.
|
| GetSectionOrder |
Returns the order of the section with the specified name.
|
| GetSectionOutput |
Gets the IniFileSection output which is written to the ini file.
|
| GetType | (Inherited from Object.) |
| KeyHasData |
Returns whether or not the supplied key contains data.
|
| KeyNameCount |
Returns the count of keys with the name keyName appearing in sectionName.
|
| KeyNameExists |
Returns whether or not a key with the name keyName exists in sectionName.
|
| MakeKey |
Creates a new unattached IniFileKey.
|
| MakeSection |
Creates a new unattached IniFileSection.
|
| MemberwiseClone | (Inherited from Object.) |
| ReadFile |
Reads the current contents of FileName into the object.
|
| SaveFile |
Writes the current object content to FileName.
|
| SectionHasData |
Returns whether or not the supplied section contains data.
|
| SectionNameCount |
Returns the count of sections with the specified name.
|
| SectionNameExists |
Returns whether or not a section with the specified name exists.
|
| SectionToDictionary |
Returns a dictionary lookup for the provided section's Keys.
This method does not support multiple IniFileKey with the same Name value. An exception is thrown when this is attempted. |
| SectionToKeyValuePair |
Returns an array of key value pairs representing each IniFileKey in the provided section.
This method supports multiple IniFileKeys with the same Name value. |
| SetKeyData |
Sets the data of the key with keyName within the specified IniFileSection.
Optionally, this method will create the section and/or key as needed.
|
| SetSectionData |
Sets the comments of the section with the specified name.
|
| ToDictionary |
Returns a dictionary lookup by Name for the currently loaded IniFileSections.
The inner dictionary lookup is by Name for each IniFileSection's Keys.
This method does not support multiple IniFileSections with the same Name value nor does it support a single IniFileSection which has multiple IniFileKeys with the same Name value. An exception is thrown when this is encountered. |
| ToKeyValuePair |
Returns an array of key value pairs by Name for the currently loaded IniFileSections.
The inner array of key value pairs is by IniFileKeyName for each IniFileSection.
This method supports multiple IniFileSections with the same Name value as well as a single IniFileSection which has multiple IniFileKeys with the same Name value. |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | _nameWhitespaceLiteral |
Specifies whether the key name portion of the key is whitespace sensitive.
|
| _sections |
Internal list of IniFileSections in the file.
|
| _valueWhitespaceLiteral |
Specifies whether the value portion of the key is whitespace sensitive.
|
| COMMENT |
Token at the beginning of a line which denotes a comment. (';' character.)
|
| KEY_VALUE_SEPARATOR |
Token within a IniFileKey which defines the separation of the Name and Value. ('=' character.).
Only the first token encountered in a line is processed (so the Value can contain this token in its text).
|
| SECTION_BEGIN |
Token at the beginning of a line which denotes a IniFileSection name start. ('[' character.)
|
| SECTION_END |
Token at the end of a line which denotes a IniFileSection name end. (']' character.)
|
Remarks
See Also