IniFile Class

FFF3PP

IniFile Class

This stuff is still in the planning stages. Any questions or Comments are welcome.

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:Furcadia.IO.IniFile"]

Inheritance Hierarchy
SystemObject  Furcadia.IOIniFile

Namespace:  Furcadia.IO
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 44
Syntax
[CLSCompliantAttribute(true)]
public class IniFile
<CLSCompliantAttribute(true)>
Public Class IniFile

Dim instance As IniFile
[CLSCompliantAttribute(true)]
public ref class IniFile
[<CLSCompliantAttribute(true)>]
type IniFile =  class end

The IniFile type exposes the following members.

Constructors
  NameDescription
Public methodIniFile
Initializes a new instance of the IniFile class.
Top
Properties
  NameDescription
Public propertyCode
If a Code section is detected, It's the last section in the ini file and all lines are read into here.

this is for DSC systyle wizard scripts

Public propertySections
Gets the sections.
Top
Methods
  NameDescription
Public methodAddSection
Adds a section to the IniFile object, returns a IniSection object to the new or existing object
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetKeyValue
Gets the key value.
Public methodGetSection
Gets the section.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoad
Loads the Reads the data in the ini file into the IniFile object
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveAllSections
Removes all existing sections, returns trus on success
Public methodRemoveKey
Remove a key by section name and key name
Public methodRemoveSection(String)
Removes a section by its name sSection, returns trus on success
Public methodRemoveSection(IniFileIniSection)
Removes section by object, returns trus on success
Public methodRenameKey
Renames an existing key returns true on success, false if the key didn't exist or there was another section with the same sNewKey
Public methodRenameSection
Renames an existing section returns true on success, false if the section didn't exist or there was another section with the same sNewSection
Public methodSave
Used to save the data back to the file or your choice
Public methodSetKeyValue
Sets a KeyValuePair in a certain section
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsDouble (Defined by ObjectExtensions.)
Public Extension MethodAsInt16 (Defined by ObjectExtensions.)
Public Extension MethodAsInt32 (Defined by ObjectExtensions.)
Public Extension MethodAsInt64 (Defined by ObjectExtensions.)
Public Extension MethodAsString (Defined by ObjectExtensions.)
Top
See Also