inifile(n) 0.1 inifile "Parsing of Windows INI files"

NAME

inifile - Parsing of Windows INI files

SYNOPSIS

package require Tcl 8.4
package require inifile ?0.1?

::ini::open file ?mode?
::ini::close ini
::ini::commit ini
::ini::revert ini
::ini::filename ini
::ini::sections ini
::ini::keys ini section
::ini::get ini section
::ini::exists ini section ?key?
::ini::value ini section key
::ini::set ini section key value
::ini::delete ini section ?key?
::ini::comment ini section ?key? ?text...?

DESCRIPTION

This package provides an interface for easy manipulation of Windows INI files.

::ini::open file ?mode?
Opens an INI file and returns a handle that is used by other commands. Mode has the same types as the open command. The default mode is r+.

::ini::close ini
Close the specified handle. If any changes were made and not written by commit they are lost.

::ini::commit ini
Writes the file and all changes to disk. The sections are written in arbitrary order. The keys in a section are written in alphabetical order.

::ini::revert ini
Rolls all changes made to the inifile object back to the last committed state.

::ini::filename ini
Returns the name of the file the ini object is associated with.

::ini::sections ini
Returns a list of all the names of the existing sections in the file handle specified.

::ini::keys ini section
Returns a list of all they key names in the section and file specified.

::ini::get ini section
Returns a list of key value pairs that exist in the section and file specified.

::ini::exists ini section ?key?
Returns a boolean value indicating the existance of the specified section as a whole or the specified key within that section.

::ini::value ini section key
Returns the value of the named key from the specified section.

::ini::set ini section key value
Sets the value of the key in the specified section. If the section does not exist then a new one is created.

::ini::delete ini section ?key?
Removes the key or the entire section and all its keys.

::ini::comment ini section ?key? ?text...?
Reads and modifies comments for sections and keys.