T_Furcadia_IO_IniFile - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

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

documentation for "T:Furcadia.IO.IniFile"]

Inheritance Hierarchy

System.Object
  Furcadia.IO.IniFile
Namespace: Furcadia.IO
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

[CLSCompliantAttribute(true)]
public class IniFile

VB

<CLSCompliantAttribute(true)>
Public Class IniFile

VB Usage

Dim instance As IniFile

C++

[CLSCompliantAttribute(true)]
public ref class IniFile

F#

[<CLSCompliantAttribute(true)>]
type IniFile =  class end

The IniFile type exposes the following members.

Constructors

 

Name Description
Public method IniFile Initializes a new instance of the IniFile class.
  Back to Top

Properties

 

Name Description
Public property Code 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 property Sections Gets the sections.
  Back to Top

Methods

 

Name Description
Public method AddSection Adds a section to the IniFile object, returns a IniSection object to the new or existing object
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetKeyValue Gets the key value.
Public method GetSection Gets the section.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Load Loads the Reads the data in the ini file into the IniFile object
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RemoveAllSections Removes all existing sections, returns trus on success
Public method RemoveKey Remove a key by section name and key name
Public method RemoveSection(String) Removes a section by its name sSection, returns trus on success
Public method RemoveSection(IniFile.IniSection) Removes section by object, returns trus on success
Public method RenameKey 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 method RenameSection 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 method Save Used to save the data back to the file or your choice
Public method SetKeyValue Sets a KeyValuePair in a certain section
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Extension Methods

 

Name Description
Public Extension Method AsDouble (Defined by ObjectExtensions.)
Public Extension Method AsInt16 (Defined by ObjectExtensions.)
Public Extension Method AsInt32 (Defined by ObjectExtensions.)
Public Extension Method AsInt64 (Defined by ObjectExtensions.)
Public Extension Method AsString (Defined by ObjectExtensions.)
  Back to Top

See Also

Reference

Furcadia.IO Namespace

⚠️ **GitHub.com Fallback** ⚠️