1<?xml version="1.0"?>
2<NiniDocs>
3
4<Class name="IniConfigSource">
5	<docs>
6		<summary>Class for loading an INI file.</summary>
7	</docs>
8
9	<Constructor name="Constructor">
10		<docs>
11			<summary>Constructor.  Loads an empty INI source.</summary>
12			<remarks>
13				This constructor is useful if you want to create an INI source
14				programmatically.  You can then call one of the <see cref="Save"/>
15				methods to save it to a file or object.
16			</remarks>
17		</docs>
18	</Constructor>
19
20	<Constructor name="ConstructorPath">
21		<docs>
22			<summary>Constructor.  Loads an INI file source.</summary>
23			<remarks>
24				Loads this up from a file.
25			</remarks>
26			<param name="filePath">
27				Path to the file to load.
28			</param>
29		</docs>
30	</Constructor>
31
32	<Constructor name="ConstructorTextReader">
33		<docs>
34			<summary>Constructor.  Loads an INI file source.</summary>
35			<remarks>
36				This is a non-savable source unless you call one of the
37				overloaded <see cref="Save"/> methods.
38			</remarks>
39			<param name="reader">
40				TextReader to load.
41			</param>
42		</docs>
43	</Constructor>
44
45	<Constructor name="ConstructorStream">
46		<docs>
47			<summary>Constructor.  Loads an INI file source.</summary>
48			<remarks>
49				This is a non-savable source unless you call one of the
50				overloaded <see cref="Save"/> methods.
51			</remarks>
52			<param name="stream">
53				Stream to load.
54			</param>
55		</docs>
56	</Constructor>
57
58	<Constructor name="ConstructorIniDocument">
59		<docs>
60			<summary>Constructor.  Loads an INI file source.</summary>
61			<remarks>
62				This is a non-savable source unless you call one of the
63				overloaded <see cref="Save"/> methods.
64			</remarks>
65			<param name="document">
66				The IniDocument.
67			</param>
68		</docs>
69	</Constructor>
70
71	<Property name="CaseSensitive">
72		<docs>
73			<summary>
74				Gets or sets whether key values will be accessed ignoring case.
75			</summary>
76		</docs>
77	</Property>
78
79	<Property name="SavePath">
80		<docs>
81			<summary>
82				The path where the document will be saved.
83			</summary>
84			<remarks>
85				This path is set when the class is loaded with a path or
86				saved with a path (using the Save (string) method).  Otherwise
87				the value will be <code>null</code>.  If it is <code>null</code>
88				then calling save will cause an exception to be thrown.
89			</remarks>
90		</docs>
91	</Property>
92
93	<Method name="LoadPath">
94		<docs>
95			<summary>Loads an INI file source.</summary>
96			<remarks>
97				Loads this up from a file.
98			</remarks>
99			<param name="filePath">
100				Path to the file to load.
101			</param>
102		</docs>
103	</Method>
104
105	<Method name="LoadTextReader">
106		<docs>
107			<summary>Loads an INI file source.</summary>
108			<remarks>
109				This is a non-savable source unless you call one of the
110				overloaded <see cref="Save"/> methods.
111			</remarks>
112			<param name="reader">
113				TextReader to load.
114			</param>
115		</docs>
116	</Method>
117
118	<Method name="LoadStream">
119		<docs>
120			<summary>Loads an INI file source.</summary>
121			<remarks>
122				This is a non-savable source unless you call one of the
123				overloaded <see cref="Save"/> methods.
124			</remarks>
125			<param name="stream">
126				Stream to load.
127			</param>
128		</docs>
129	</Method>
130
131	<Method name="LoadIniDocument">
132		<docs>
133			<summary>Loads an INI file source.</summary>
134			<remarks>
135				This is a non-savable source unless you call one of the
136				overloaded <see cref="Save"/> methods.
137			</remarks>
138			<param name="document">
139				The IniDocument.
140			</param>
141		</docs>
142	</Method>
143
144	<Method name="Save">
145		<docs>
146			<summary>
147				Saves all configuration values.
148			</summary>
149			<remarks>
150				If the <see cref="SavePath"/> is <code>null</code> then this
151				will throw an exception.
152			</remarks>
153			<exception cref="Exception">
154				The <see cref="SavePath"/> is <code>null</code>.
155			</exception>
156		</docs>
157	</Method>
158
159	<Method name="SavePath">
160		<docs>
161			<summary>
162				Saves all configuration values to a path.
163			</summary>
164			<remarks>
165				This sets the <see cref="SavePath"/> to <code>path</code>.
166			</remarks>
167			<param name="path">
168				Path to save the file.
169			</param>
170			<exception cref="Exception">
171				An error has occurred.
172			</exception>
173		</docs>
174	</Method>
175
176	<Method name="SaveTextWriter">
177		<docs>
178			<summary>
179				Saves all configuration values to a <b>TextWriter</b>.
180			</summary>
181			<remarks>
182				This sets the <see cref="SavePath"/> to <code>null</code>.
183			</remarks>
184			<param name="writer">
185				The TextWriter to save the document.
186			</param>
187			<exception cref="Exception">
188				An error has occurred.
189			</exception>
190		</docs>
191	</Method>
192
193	<Method name="SaveStream">
194		<docs>
195			<summary>Writes the INI data to a Stream.</summary>
196			<param name="stream">Stream object</param>
197		</docs>
198	</Method>
199
200	<Method name="ToString">
201		<docs>
202			<summary>
203				Returns all characters in the document.
204			</summary>
205			<remarks>
206				It returns the INI string of the document.
207			</remarks>
208		</docs>
209	</Method>
210
211</Class>
212
213</NiniDocs>
214