C# Class pocorall.IniFile

Exibir arquivo Open project: pocorall/scm-notifier

Public Properties

Property	Type	Description
FileName	string
FullFileName	string
Section	string

Public Methods

Method	Description
DeleteKey ( string key ) : void	Deletes a key from the active section.
DeleteKey ( string section, string key ) : void	Deletes a key from the specified section.
DeleteSection ( string section ) : void	Deletes a section from an INI file.
GetKeys ( string section ) : string[]	Retrieves all the keys for the specified section of an INI file.
GetKeysAndValues ( string section ) : string[]	Retrieves all the keys and values for the specified section of an INI file.
GetSectionNames ( ) : string[]	Retrieves a list of all available sections in the INI file.
IniFile ( string fileName, bool checkExistance ) : System	Constructs a new IniFile instance
ReadBoolean ( string key ) : bool	Reads a Boolean from the specified key of the specified section.
ReadBoolean ( string key, bool defVal ) : bool	Reads a Boolean from the specified key of the specified section.
ReadBoolean ( string section, string key ) : bool	Reads a Boolean from the specified key of the specified section.
ReadBoolean ( string section, string key, bool defVal ) : bool	Reads a Boolean from the specified key of the specified section.
ReadByteArray ( string key ) : byte[]	Reads a Byte array from the specified key of the active section.
ReadByteArray ( string section, string key ) : byte[]	Reads a Byte array from the specified key of the specified section.
ReadInteger ( string key ) : int	Reads an Integer from the specified key of the active section.
ReadInteger ( string key, int defVal ) : int	Reads an Integer from the specified key of the active section.
ReadInteger ( string section, string key ) : int	Reads an Integer from the specified key of the specified section.
ReadInteger ( string section, string key, int defVal ) : int	Reads an Integer from the specified key of the specified section.
ReadLong ( string key ) : long	Reads a Long from the specified key of the active section.
ReadLong ( string key, long defVal ) : long	Reads a Long from the specified key of the active section.
ReadLong ( string section, string key ) : long	Reads a Long from the specified key of the specified section.
ReadLong ( string section, string key, long defVal ) : long	Reads a Long from the specified key of the specified section.
ReadString ( string key ) : string	Reads a String from the specified key of the active section.
ReadString ( string section, string key ) : string	Reads a String from the specified key of the specified section.
ReadString ( string section, string key, string defVal ) : string	Reads a String from the specified key of the specified section.
Write ( string key, bool value ) : void	Writes a Boolean to the specified key in the active section.
Write ( string key, byte value ) : void	Writes a Byte array to the specified key in the active section.
Write ( string key, int value ) : void	Writes an Integer to the specified key in the active section.
Write ( string key, long value ) : void	Writes a Long to the specified key in the active section.
Write ( string key, string value ) : void	Writes a String to the specified key in the active section.
Write ( string section, string key, bool value ) : void	Writes a Boolean to the specified key in the specified section.
Write ( string section, string key, byte value ) : void	Writes a Byte array to the specified key in the specified section.
Write ( string section, string key, byte value, int offset, int length ) : void	Writes a Byte array to the specified key in the specified section.
Write ( string section, string key, int value ) : void	Writes an Integer to the specified key in the specified section.
Write ( string section, string key, long value ) : void	Writes a Long to the specified key in the specified section.
Write ( string section, string key, string value ) : void	Writes a String to the specified key in the specified section.

Private Methods

Method	Description
Flush ( ) : void
GetPrivateProfileInt ( string lpApplicationName, string lpKeyName, int nDefault, string lpFileName ) : int
GetPrivateProfileSection ( string lpAppName, byte lpReturnedString, int nSize, string lpFileName ) : int
GetPrivateProfileSectionNames ( byte lpszReturnBuffer, int nSize, string lpFileName ) : int
GetPrivateProfileString ( string lpApplicationName, string lpKeyName, string lpDefault, byte lpReturnedString, int nSize, string lpFileName ) : int
WritePrivateProfileSection ( string lpAppName, string lpString, string lpFileName ) : int
WritePrivateProfileString ( string lpApplicationName, string lpKeyName, string lpString, string lpFileName ) : int

Method Details

DeleteKey() public method

Deletes a key from the active section.

public DeleteKey ( string key ) : void
key	string	The key to delete.
return	void

DeleteKey() public method

Deletes a key from the specified section.

public DeleteKey ( string section, string key ) : void
section	string	The section to delete from.
key	string	The key to delete.
return	void

DeleteSection() public method

Deletes a section from an INI file.

public DeleteSection ( string section ) : void
section	string	The section to delete.
return	void

GetKeys() public method

Retrieves all the keys for the specified section of an INI file.

public GetKeys ( string section ) : string[]
section	string	Name of the section in which data is written.
return	string[]

GetKeysAndValues() public method

Retrieves all the keys and values for the specified section of an INI file.

public GetKeysAndValues ( string section ) : string[]
section	string	Name of the section in which data is written.
return	string[]

GetSectionNames() public method

Retrieves a list of all available sections in the INI file.

public GetSectionNames ( ) : string[]
return	string[]

IniFile() public method

Constructs a new IniFile instance

public IniFile ( string fileName, bool checkExistance ) : System
fileName	string
checkExistance	bool
return	System

ReadBoolean() public method

Reads a Boolean from the specified key of the specified section.

public ReadBoolean ( string key ) : bool
key	string	The key from which to return the value.
return	bool

ReadBoolean() public method

Reads a Boolean from the specified key of the specified section.

public ReadBoolean ( string key, bool defVal ) : bool
key	string	The key from which to return the value.
defVal	bool	The value to return if the specified key isn't found.
return	bool

ReadBoolean() public method

Reads a Boolean from the specified key of the specified section.

public ReadBoolean ( string section, string key ) : bool
section	string	The section to search in.
key	string	The key from which to return the value.
return	bool

ReadBoolean() public method

Reads a Boolean from the specified key of the specified section.

public ReadBoolean ( string section, string key, bool defVal ) : bool
section	string	The section to search in.
key	string	The key from which to return the value.
defVal	bool	The value to return if the specified key isn't found.
return	bool

ReadByteArray() public method

Reads a Byte array from the specified key of the active section.

public ReadByteArray ( string key ) : byte[]
key	string	The key from which to return the value.
return	byte[]

ReadByteArray() public method

Reads a Byte array from the specified key of the specified section.

public ReadByteArray ( string section, string key ) : byte[]
section	string	The section to search in.
key	string	The key from which to return the value.
return	byte[]

ReadInteger() public method

Reads an Integer from the specified key of the active section.

public ReadInteger ( string key ) : int
key	string	The key from which to return the value.
return	int

ReadInteger() public method

Reads an Integer from the specified key of the active section.

public ReadInteger ( string key, int defVal ) : int
key	string	The key from which to return the value.
defVal	int	The section to search in.
return	int

ReadInteger() public method

Reads an Integer from the specified key of the specified section.

public ReadInteger ( string section, string key ) : int
section	string	The section to search in.
key	string	The key from which to return the value.
return	int

ReadInteger() public method

Reads an Integer from the specified key of the specified section.

public ReadInteger ( string section, string key, int defVal ) : int
section	string	The section to search in.
key	string	The key from which to return the value.
defVal	int	The value to return if the specified key isn't found.
return	int

ReadLong() public method

Reads a Long from the specified key of the active section.

public ReadLong ( string key ) : long
key	string	The key from which to return the value.
return	long

ReadLong() public method

Reads a Long from the specified key of the active section.

public ReadLong ( string key, long defVal ) : long
key	string	The key from which to return the value.
defVal	long	The section to search in.
return	long

ReadLong() public method

Reads a Long from the specified key of the specified section.

public ReadLong ( string section, string key ) : long
section	string	The section to search in.
key	string	The key from which to return the value.
return	long

ReadLong() public method

Reads a Long from the specified key of the specified section.

public ReadLong ( string section, string key, long defVal ) : long
section	string	The section to search in.
key	string	The key from which to return the value.
defVal	long	The value to return if the specified key isn't found.
return	long

ReadString() public method

Reads a String from the specified key of the active section.

public ReadString ( string key ) : string
key	string	The key from which to return the value.
return	string

ReadString() public method

Reads a String from the specified key of the specified section.

public ReadString ( string section, string key ) : string
section	string	The section to search in.
key	string	The key from which to return the value.
return	string

ReadString() public method

Reads a String from the specified key of the specified section.

public ReadString ( string section, string key, string defVal ) : string
section	string	The section to search in.
key	string	The key from which to return the value.
defVal	string	The value to return if the specified key isn't found.
return	string

Write() public method

Writes a Boolean to the specified key in the active section.

public Write ( string key, bool value ) : void
key	string	The key to write to.
value	bool	The value to write.
return	void

Write() public method

Writes a Byte array to the specified key in the active section.

public Write ( string key, byte value ) : void
key	string	The key to write to.
value	byte	The value to write.
return	void

Write() public method

Writes an Integer to the specified key in the active section.

public Write ( string key, int value ) : void
key	string	The key to write to.
value	int	The value to write.
return	void

Write() public method

Writes a Long to the specified key in the active section.

public Write ( string key, long value ) : void
key	string	The key to write to.
value	long	The value to write.
return	void

Write() public method

Writes a String to the specified key in the active section.

public Write ( string key, string value ) : void
key	string	The key to write to.
value	string	The value to write.
return	void

Write() public method

Writes a Boolean to the specified key in the specified section.

public Write ( string section, string key, bool value ) : void
section	string	The section to write in.
key	string	The key to write to.
value	bool	The value to write.
return	void

Write() public method

Writes a Byte array to the specified key in the specified section.

public Write ( string section, string key, byte value ) : void
section	string	The section to write in.
key	string	The key to write to.
value	byte	The value to write.
return	void

Write() public method

Writes a Byte array to the specified key in the specified section.

public Write ( string section, string key, byte value, int offset, int length ) : void
section	string	The section to write in.
key	string	The key to write to.
value	byte	The value to write.
offset	int	An offset in value.
length	int	The number of elements of value to convert.
return	void

Write() public method

Writes an Integer to the specified key in the specified section.

public Write ( string section, string key, int value ) : void
section	string	The section to write in.
key	string	The key to write to.
value	int	The value to write.
return	void

Write() public method

Writes a Long to the specified key in the specified section.

public Write ( string section, string key, long value ) : void
section	string	The section to write in.
key	string	The key to write to.
value	long	The value to write.
return	void

Write() public method

Writes a String to the specified key in the specified section.

public Write ( string section, string key, string value ) : void
section	string	Specifies the section to write in.
key	string	Specifies the key to write to.
value	string	Specifies the value to write.
return	void

Property Details

FileName public_oe property

public string FileName
return	string

FullFileName public_oe property

Full path to the INI file.

public string FullFileName
return	string

Section public_oe property

Active section name

public string Section
return	string