/*
IniReader class for C#
Version: 1.0 Date: 2002/04/24
*/
/*
Copyright © 2002, The KPD-Team
All rights reserved.
http://www.mentalis.org/
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Neither the name of the KPD-Team, nor the names of its contributors
may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Text;
using System.Collections;
using System.Runtime.InteropServices;
// The Org.Mentalis.Files contains a number of classes that read from or write to special files.
namespace Org.Mentalis.Files
{
///
/// The INIReader class can read keys from and write keys to an INI file.
///
///
/// This class uses several Win32 API functions to read from and write to INI files. It will not work on Linux or FreeBSD.
///
public class IniReader
{
// API declarations
///
/// The GetPrivateProfileInt function retrieves an integer associated with a key in the specified section of an initialization file.
///
/// Pointer to a null-terminated string specifying the name of the section in the initialization file.
/// Pointer to the null-terminated string specifying the name of the key whose value is to be retrieved. This value is in the form of a string; the GetPrivateProfileInt function converts the string into an integer and returns the integer.
/// Specifies the default value to return if the key name cannot be found in the initialization file.
/// Pointer to a null-terminated string that specifies the name of the initialization file. If this parameter does not contain a full path to the file, the system searches for the file in the Windows directory.
/// The return value is the integer equivalent of the string following the specified key name in the specified initialization file. If the key is not found, the return value is the specified default value. If the value of the key is less than zero, the return value is zero.
[DllImport("KERNEL32.DLL", EntryPoint = "GetPrivateProfileIntA", CharSet = CharSet.Ansi)]
private static extern int GetPrivateProfileInt(string lpApplicationName, string lpKeyName, int nDefault, string lpFileName);
///
/// The WritePrivateProfileString function copies a string into the specified section of an initialization file.
///
/// Pointer to a null-terminated string containing the name of the section to which the string will be copied. If the section does not exist, it is created. The name of the section is case-independent; the string can be any combination of uppercase and lowercase letters.
/// Pointer to the null-terminated string containing the name of the key to be associated with a string. If the key does not exist in the specified section, it is created. If this parameter is NULL, the entire section, including all entries within the section, is deleted.
/// Pointer to a null-terminated string to be written to the file. If this parameter is NULL, the key pointed to by the lpKeyName parameter is deleted.
/// Pointer to a null-terminated string that specifies the name of the initialization file.
/// If the function successfully copies the string to the initialization file, the return value is nonzero; if the function fails, or if it flushes the cached version of the most recently accessed initialization file, the return value is zero.
[DllImport("KERNEL32.DLL", EntryPoint = "WritePrivateProfileStringA", CharSet = CharSet.Ansi)]
private static extern int WritePrivateProfileString(string lpApplicationName, string lpKeyName, string lpString, string lpFileName);
///
/// The GetPrivateProfileString function retrieves a string from the specified section in an initialization file.
///
/// Pointer to a null-terminated string that specifies the name of the section containing the key name. If this parameter is NULL, the GetPrivateProfileString function copies all section names in the file to the supplied buffer.
/// Pointer to the null-terminated string specifying the name of the key whose associated string is to be retrieved. If this parameter is NULL, all key names in the section specified by the lpAppName parameter are copied to the buffer specified by the lpReturnedString parameter.
/// Pointer to a null-terminated default string. If the lpKeyName key cannot be found in the initialization file, GetPrivateProfileString copies the default string to the lpReturnedString buffer. This parameter cannot be NULL.
Avoid specifying a default string with trailing blank characters. The function inserts a null character in the lpReturnedString buffer to strip any trailing blanks.
/// Pointer to the buffer that receives the retrieved string.
/// Specifies the size, in TCHARs, of the buffer pointed to by the lpReturnedString parameter.
/// Pointer to a null-terminated string that specifies the name of the initialization file. If this parameter does not contain a full path to the file, the system searches for the file in the Windows directory.
/// The return value is the number of characters copied to the buffer, not including the terminating null character.
[DllImport("KERNEL32.DLL", EntryPoint = "GetPrivateProfileStringA", CharSet = CharSet.Ansi)]
private static extern int GetPrivateProfileString(string lpApplicationName, string lpKeyName, string lpDefault, StringBuilder lpReturnedString, int nSize, string lpFileName);
///
/// The GetPrivateProfileSectionNames function retrieves the names of all sections in an initialization file.
///
/// Pointer to a buffer that receives the section names associated with the named file. The buffer is filled with one or more null-terminated strings; the last string is followed by a second null character.
/// Specifies the size, in TCHARs, of the buffer pointed to by the lpszReturnBuffer parameter.
/// Pointer to a null-terminated string that specifies the name of the initialization file. If this parameter is NULL, the function searches the Win.ini file. If this parameter does not contain a full path to the file, the system searches for the file in the Windows directory.
/// The return value specifies the number of characters copied to the specified buffer, not including the terminating null character. If the buffer is not large enough to contain all the section names associated with the specified initialization file, the return value is equal to the length specified by nSize minus two.
[DllImport("KERNEL32.DLL", EntryPoint = "GetPrivateProfileSectionNamesA", CharSet = CharSet.Ansi)]
private static extern int GetPrivateProfileSectionNames(byte[] lpszReturnBuffer, int nSize, string lpFileName);
///
/// The WritePrivateProfileSection function replaces the keys and values for the specified section in an initialization file.
///
/// Pointer to a null-terminated string specifying the name of the section in which data is written. This section name is typically the name of the calling application.
/// Pointer to a buffer containing the new key names and associated values that are to be written to the named section.
/// Pointer to a null-terminated string containing the name of the initialization file. If this parameter does not contain a full path for the file, the function searches the Windows directory for the file. If the file does not exist and lpFileName does not contain a full path, the function creates the file in the Windows directory. The function does not create a file if lpFileName contains the full path and file name of a file that does not exist.
/// If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero.
[DllImport("KERNEL32.DLL", EntryPoint = "WritePrivateProfileSectionA", CharSet = CharSet.Ansi)]
private static extern int WritePrivateProfileSection(string lpAppName, string lpString, string lpFileName);
/// Constructs a new IniReader instance.
/// Specifies the full path to the INI file (the file doesn't have to exist).
public IniReader(string file)
{
Filename = file;
}
/// Gets or sets the full path to the INI file.
/// A String representing the full path to the INI file.
public string Filename
{
get
{
return m_Filename;
}
set
{
m_Filename = value;
}
}
/// Gets or sets the section you're working in. (aka 'the active section')
/// A String representing the section you're working in.
public string Section
{
get
{
return m_Section;
}
set
{
m_Section = value;
}
}
/// Reads an Integer from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// The value to return if the specified key isn't found.
/// Returns the value of the specified section/key pair, or returns the default value if the specified section/key pair isn't found in the INI file.
public int ReadInteger(string section, string key, int defVal)
{
return GetPrivateProfileInt(section, key, defVal, Filename);
}
/// Reads an Integer from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// Returns the value of the specified section/key pair, or returns 0 if the specified section/key pair isn't found in the INI file.
public int ReadInteger(string section, string key)
{
return ReadInteger(section, key, 0);
}
/// Reads an Integer from the specified key of the active section.
/// The key from which to return the value.
/// The section to search in.
/// Returns the value of the specified Key, or returns the default value if the specified Key isn't found in the active section of the INI file.
public int ReadInteger(string key, int defVal)
{
return ReadInteger(Section, key, defVal);
}
/// Reads an Integer from the specified key of the active section.
/// The key from which to return the value.
/// Returns the value of the specified key, or returns 0 if the specified key isn't found in the active section of the INI file.
public int ReadInteger(string key)
{
return ReadInteger(key, 0);
}
/// Reads a String from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// The value to return if the specified key isn't found.
/// Returns the value of the specified section/key pair, or returns the default value if the specified section/key pair isn't found in the INI file.
public string ReadString(string section, string key, string defVal)
{
StringBuilder sb = new StringBuilder(MAX_ENTRY);
int Ret = GetPrivateProfileString(section, key, defVal, sb, MAX_ENTRY, Filename);
return sb.ToString();
}
/// Reads a String from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// Returns the value of the specified section/key pair, or returns an empty String if the specified section/key pair isn't found in the INI file.
public string ReadString(string section, string key)
{
return ReadString(section, key, "");
}
/// Reads a String from the specified key of the active section.
/// The key from which to return the value.
/// Returns the value of the specified key, or returns an empty String if the specified key isn't found in the active section of the INI file.
public string ReadString(string key)
{
return ReadString(Section, key);
}
/// Reads a Long from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// The value to return if the specified key isn't found.
/// Returns the value of the specified section/key pair, or returns the default value if the specified section/key pair isn't found in the INI file.
public long ReadLong(string section, string key, long defVal)
{
return long.Parse(ReadString(section, key, defVal.ToString()));
}
/// Reads a Long from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// Returns the value of the specified section/key pair, or returns 0 if the specified section/key pair isn't found in the INI file.
public long ReadLong(string section, string key)
{
return ReadLong(section, key, 0);
}
/// Reads a Long from the specified key of the active section.
/// The key from which to return the value.
/// The section to search in.
/// Returns the value of the specified key, or returns the default value if the specified key isn't found in the active section of the INI file.
public long ReadLong(string key, long defVal)
{
return ReadLong(Section, key, defVal);
}
/// Reads a Long from the specified key of the active section.
/// The key from which to return the value.
/// Returns the value of the specified Key, or returns 0 if the specified Key isn't found in the active section of the INI file.
public long ReadLong(string key)
{
return ReadLong(key, 0);
}
/// Reads a Byte array from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// Returns the value of the specified section/key pair, or returns null (Nothing in VB.NET) if the specified section/key pair isn't found in the INI file.
public byte[] ReadByteArray(string section, string key)
{
try
{
return Convert.FromBase64String(ReadString(section, key));
}
catch { }
return null;
}
/// Reads a Byte array from the specified key of the active section.
/// The key from which to return the value.
/// Returns the value of the specified key, or returns null (Nothing in VB.NET) if the specified key pair isn't found in the active section of the INI file.
public byte[] ReadByteArray(string key)
{
return ReadByteArray(Section, key);
}
/// Reads a Boolean from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// The value to return if the specified key isn't found.
/// Returns the value of the specified section/key pair, or returns the default value if the specified section/key pair isn't found in the INI file.
public bool ReadBoolean(string section, string key, bool defVal)
{
return Boolean.Parse(ReadString(section, key, defVal.ToString()));
}
/// Reads a Boolean from the specified key of the specified section.
/// The section to search in.
/// The key from which to return the value.
/// Returns the value of the specified section/key pair, or returns false if the specified section/key pair isn't found in the INI file.
public bool ReadBoolean(string section, string key)
{
return ReadBoolean(section, key, false);
}
/// Reads a Boolean from the specified key of the specified section.
/// The key from which to return the value.
/// The value to return if the specified key isn't found.
/// Returns the value of the specified key pair, or returns the default value if the specified key isn't found in the active section of the INI file.
public bool ReadBoolean(string key, bool defVal)
{
return ReadBoolean(Section, key, defVal);
}
/// Reads a Boolean from the specified key of the specified section.
/// The key from which to return the value.
/// Returns the value of the specified key, or returns false if the specified key isn't found in the active section of the INI file.
public bool ReadBoolean(string key)
{
return ReadBoolean(Section, key);
}
/// Writes an Integer to the specified key in the specified section.
/// The section to write in.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, int value)
{
return Write(section, key, value.ToString());
}
/// Writes an Integer to the specified key in the active section.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string key, int value)
{
return Write(Section, key, value);
}
/// Writes a String to the specified key in the specified section.
/// Specifies the section to write in.
/// Specifies the key to write to.
/// Specifies the value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, string value)
{
return (WritePrivateProfileString(section, key, value, Filename) != 0);
}
/// Writes a String to the specified key in the active section.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string key, string value)
{
return Write(Section, key, value);
}
/// Writes a Long to the specified key in the specified section.
/// The section to write in.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, long value)
{
return Write(section, key, value.ToString());
}
/// Writes a Long to the specified key in the active section.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string key, long value)
{
return Write(Section, key, value);
}
/// Writes a Byte array to the specified key in the specified section.
/// The section to write in.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, byte[] value)
{
if (value == null)
return Write(section, key, (string)null);
else
return Write(section, key, value, 0, value.Length);
}
/// Writes a Byte array to the specified key in the active section.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string key, byte[] value)
{
return Write(Section, key, value);
}
/// Writes a Byte array to the specified key in the specified section.
/// The section to write in.
/// The key to write to.
/// The value to write.
/// An offset in value.
/// The number of elements of value to convert.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, byte[] value, int offset, int length)
{
if (value == null)
return Write(section, key, (string)null);
else
return Write(section, key, Convert.ToBase64String(value, offset, length));
}
/// Writes a Boolean to the specified key in the specified section.
/// The section to write in.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string section, string key, bool value)
{
return Write(section, key, value.ToString());
}
/// Writes a Boolean to the specified key in the active section.
/// The key to write to.
/// The value to write.
/// Returns true if the function succeeds, false otherwise.
public bool Write(string key, bool value)
{
return Write(Section, key, value);
}
/// Deletes a key from the specified section.
/// The section to delete from.
/// The key to delete.
/// Returns true if the function succeeds, false otherwise.
public bool DeleteKey(string section, string key)
{
return (WritePrivateProfileString(section, key, null, Filename) != 0);
}
/// Deletes a key from the active section.
/// The key to delete.
/// Returns true if the function succeeds, false otherwise.
public bool DeleteKey(string key)
{
return (WritePrivateProfileString(Section, key, null, Filename) != 0);
}
/// Deletes a section from an INI file.
/// The section to delete.
/// Returns true if the function succeeds, false otherwise.
public bool DeleteSection(string section)
{
return WritePrivateProfileSection(section, null, Filename) != 0;
}
/// Retrieves a list of all available sections in the INI file.
/// Returns an ArrayList with all available sections.
public ArrayList GetSectionNames()
{
try
{
byte[] buffer = new byte[MAX_ENTRY];
GetPrivateProfileSectionNames(buffer, MAX_ENTRY, Filename);
string[] parts = Encoding.ASCII.GetString(buffer).Trim('\0').Split('\0');
return new ArrayList(parts);
}
catch { }
return null;
}
//Private variables and constants
///
/// Holds the full path to the INI file.
///
private string m_Filename;
///
/// Holds the active section name
///
private string m_Section;
///
/// The maximum number of bytes in a section buffer.
///
private const int MAX_ENTRY = 32768;
}
}