Config Helper
IniReaderWriter Class Members
Fields  Properties  Methods 


KellermanSoftware.ConfigHelper Namespace : IniReaderWriter Class

The following tables list the members exposed by IniReaderWriter.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Field Name for the global section  
Top
Public Properties
 NameDescription
Public Property The comment character. By default it is a semicolon  
Public Property The delimiter between settings and values. By default it is an equals sign  
Public PropertyOverride the file encoding. The default is Encoding.Default.
See http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx  
Public PropertyIf true, escape characters will be processed. The default is false.
See http://en.wikipedia.org/wiki/INI_file  
Top
Public Methods
 NameDescription
Public MethodDelete a setting from an INI file
No COM Interop is used
If the file does not exist or the value does not exist, false will be returned.  
Public Methodstatic (Shared in Visual Basic)Managed version of GetPrivateProfileInt
No COM Interop is used
If the file does not exist or the value is not in the file, the defaultValue is used.
See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms724348%28v=vs.85%29.aspx  
Public Methodstatic (Shared in Visual Basic)Overloaded. Managed version of GetPrivateProfileString
No COM Interop is used
If the file does not exist or the value is not in the file, the defaultValue is used.
See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms724348%28v=vs.85%29.aspx  
Public MethodGet a list of the sections in an INI file. The global section will be returned as GLOBAL. See also GLOBAL_SECTION_NAME
No COM Interop is used
If the file does not exist, no sections will be returned.  
Public MethodGet a dictionary of the key value pairs for a section in an INI file
No COM Interop is used
If the file does not exist, no items will be returned.  
Public MethodGet the value for a setting in a section
No COM Interop is used
If the file does not exist or the setting does not exist, the value returned will be null.  
Public MethodSave a value to an INI file
No COM Interop is used
If the file does not exist it will be created. If the section does not exist it will be created. If the setting already exists it will be updated. If the setting does not exist, it will be added.
 
Public MethodReturn true if a setting exists
No COM Interop is used
If the file does not exist or the setting does not exist, the value returned will be false.  
Public Methodstatic (Shared in Visual Basic)Managed version of WritePrivateProfileString
No COM Interop is used
If the file does not exist it will be created. If the section does not exist it will be created. If the setting already exists it will be updated. If the setting does not exist, it will be added.
See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms724348%28v=vs.85%29.aspx  
Top
See Also

Reference

IniReaderWriter Class
KellermanSoftware.ConfigHelper Namespace