Drop this one too
[mono.git] / mcs / class / Mono.Data.SqliteClient / Documentation / en / Mono.Data.SqliteClient / SqliteDataReader.xml
1 <Type Name="SqliteDataReader" FullName="Mono.Data.SqliteClient.SqliteDataReader">
2   <TypeSignature Language="C#" Value="public class SqliteDataReader : System.Data.Common.DbDataReader" />
3   <AssemblyInfo>
4     <AssemblyName>Mono.Data.SqliteClient</AssemblyName>
5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
7   </AssemblyInfo>
8   <Base>
9     <BaseTypeName>System.Data.Common.DbDataReader</BaseTypeName>
10   </Base>
11   <Interfaces>
12   </Interfaces>
13   <Docs>
14     <summary>The DataReader represents a table of results returned from a query.</summary>
15     <remarks>
16       <para>A DataReader is returned from <see cref="M:Mono.Data.SqliteClient.SqliteCommand.ExecuteReader()" />.  The DataReader currently implemented preloads the entire into memory.</para>
17       <para>The DataReader is initially positioned before the first row of data.  <see cref="M:Mono.Data.SqliteClient.SqliteDataReader.Read()" /> must be called before accessing the data in the first row.</para>
18     </remarks>
19   </Docs>
20   <Members>
21     <Member MemberName="Close">
22       <MemberSignature Language="C#" Value="public override void Close ();" />
23       <MemberType>Method</MemberType>
24       <ReturnValue>
25         <ReturnType>System.Void</ReturnType>
26       </ReturnValue>
27       <Parameters />
28       <Docs>
29         <summary>Closes the DataReader.</summary>
30         <remarks>None.</remarks>
31       </Docs>
32       <AssemblyInfo>
33         <AssemblyVersion>2.0.0.0</AssemblyVersion>
34       </AssemblyInfo>
35     </Member>
36     <Member MemberName="Depth">
37       <MemberSignature Language="C#" Value="public override int Depth { get; }" />
38       <MemberType>Property</MemberType>
39       <ReturnValue>
40         <ReturnType>System.Int32</ReturnType>
41       </ReturnValue>
42       <Docs>
43         <summary>Returns zero.</summary>
44         <value>Zero.</value>
45         <remarks>This method is not currently used.</remarks>
46       </Docs>
47       <AssemblyInfo>
48         <AssemblyVersion>2.0.0.0</AssemblyVersion>
49       </AssemblyInfo>
50     </Member>
51     <Member MemberName="Dispose">
52       <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
53       <MemberType>Method</MemberType>
54       <AssemblyInfo>
55         <AssemblyVersion>2.0.0.0</AssemblyVersion>
56       </AssemblyInfo>
57       <ReturnValue>
58         <ReturnType>System.Void</ReturnType>
59       </ReturnValue>
60       <Parameters>
61         <Parameter Name="disposing" Type="System.Boolean" />
62       </Parameters>
63       <Docs>
64         <param name="disposing">To be added.</param>
65         <summary>To be added.</summary>
66         <remarks>To be added.</remarks>
67       </Docs>
68     </Member>
69     <Member MemberName="FieldCount">
70       <MemberSignature Language="C#" Value="public override int FieldCount { get; }" />
71       <MemberType>Property</MemberType>
72       <ReturnValue>
73         <ReturnType>System.Int32</ReturnType>
74       </ReturnValue>
75       <Docs>
76         <summary>Gets the number of columns in the table.</summary>
77         <value>The number of columns in the table.</value>
78         <remarks>None.</remarks>
79       </Docs>
80       <AssemblyInfo>
81         <AssemblyVersion>2.0.0.0</AssemblyVersion>
82       </AssemblyInfo>
83     </Member>
84     <Member MemberName="GetBoolean">
85       <MemberSignature Language="C#" Value="public override bool GetBoolean (int i);" />
86       <MemberType>Method</MemberType>
87       <ReturnValue>
88         <ReturnType>System.Boolean</ReturnType>
89       </ReturnValue>
90       <Parameters>
91         <Parameter Name="i" Type="System.Int32" />
92       </Parameters>
93       <Docs>
94         <param name="i">The column index (zero-based).</param>
95         <summary>Get the value in a column converted to a boolean.</summary>
96         <returns>The boolean value in the <paramref name="i" />th column.</returns>
97         <remarks>None.</remarks>
98       </Docs>
99       <AssemblyInfo>
100         <AssemblyVersion>2.0.0.0</AssemblyVersion>
101       </AssemblyInfo>
102     </Member>
103     <Member MemberName="GetByte">
104       <MemberSignature Language="C#" Value="public override byte GetByte (int i);" />
105       <MemberType>Method</MemberType>
106       <ReturnValue>
107         <ReturnType>System.Byte</ReturnType>
108       </ReturnValue>
109       <Parameters>
110         <Parameter Name="i" Type="System.Int32" />
111       </Parameters>
112       <Docs>
113         <param name="i">The column index (zero-based).</param>
114         <summary>Get the value in a column converted to a byte.</summary>
115         <returns>The byte value in the <paramref name="i" />th column.</returns>
116         <remarks>None.</remarks>
117       </Docs>
118       <AssemblyInfo>
119         <AssemblyVersion>2.0.0.0</AssemblyVersion>
120       </AssemblyInfo>
121     </Member>
122     <Member MemberName="GetBytes">
123       <MemberSignature Language="C#" Value="public override long GetBytes (int i, long fieldOffset, byte[] buffer, int bufferOffset, int length);" />
124       <MemberType>Method</MemberType>
125       <ReturnValue>
126         <ReturnType>System.Int64</ReturnType>
127       </ReturnValue>
128       <Parameters>
129         <Parameter Name="i" Type="System.Int32" />
130         <Parameter Name="fieldOffset" Type="System.Int64" />
131         <Parameter Name="buffer" Type="System.Byte[]" />
132         <Parameter Name="bufferOffset" Type="System.Int32" />
133         <Parameter Name="length" Type="System.Int32" />
134       </Parameters>
135       <Docs>
136         <param name="i">The column index (zero-based).</param>
137         <param name="fieldOffset">The starting byte in the field data at which to get the data.</param>
138         <param name="buffer">The buffer to fill with field data.</param>
139         <param name="bufferOffset">The starting index in the buffer to put the data.</param>
140         <param name="length">The number of bytes to retrieve and put in the buffer.</param>
141         <summary>Gets the byte data within a binary field.</summary>
142         <returns>The number of bytes copied into the buffer.</returns>
143         <remarks>None.</remarks>
144       </Docs>
145       <AssemblyInfo>
146         <AssemblyVersion>2.0.0.0</AssemblyVersion>
147       </AssemblyInfo>
148     </Member>
149     <Member MemberName="GetChar">
150       <MemberSignature Language="C#" Value="public override char GetChar (int i);" />
151       <MemberType>Method</MemberType>
152       <ReturnValue>
153         <ReturnType>System.Char</ReturnType>
154       </ReturnValue>
155       <Parameters>
156         <Parameter Name="i" Type="System.Int32" />
157       </Parameters>
158       <Docs>
159         <param name="i">The column index (zero-based).</param>
160         <summary>Get the value in a column converted to a char.</summary>
161         <returns>The char value in the <paramref name="i" />th column.</returns>
162         <remarks>None.</remarks>
163       </Docs>
164       <AssemblyInfo>
165         <AssemblyVersion>2.0.0.0</AssemblyVersion>
166       </AssemblyInfo>
167     </Member>
168     <Member MemberName="GetChars">
169       <MemberSignature Language="C#" Value="public override long GetChars (int i, long fieldOffset, char[] buffer, int bufferOffset, int length);" />
170       <MemberType>Method</MemberType>
171       <ReturnValue>
172         <ReturnType>System.Int64</ReturnType>
173       </ReturnValue>
174       <Parameters>
175         <Parameter Name="i" Type="System.Int32" />
176         <Parameter Name="fieldOffset" Type="System.Int64" />
177         <Parameter Name="buffer" Type="System.Char[]" />
178         <Parameter Name="bufferOffset" Type="System.Int32" />
179         <Parameter Name="length" Type="System.Int32" />
180       </Parameters>
181       <Docs>
182         <param name="i">The column index (zero-based).</param>
183         <param name="fieldOffset">To be added.</param>
184         <param name="buffer">To be added.</param>
185         <param name="bufferOffset">To be added.</param>
186         <param name="length">To be added.</param>
187         <summary>This method is not implemented.</summary>
188         <returns>To be added.</returns>
189         <remarks>To be added.</remarks>
190       </Docs>
191       <AssemblyInfo>
192         <AssemblyVersion>2.0.0.0</AssemblyVersion>
193       </AssemblyInfo>
194     </Member>
195     <Member MemberName="GetDataTypeName">
196       <MemberSignature Language="C#" Value="public override string GetDataTypeName (int i);" />
197       <MemberType>Method</MemberType>
198       <ReturnValue>
199         <ReturnType>System.String</ReturnType>
200       </ReturnValue>
201       <Parameters>
202         <Parameter Name="i" Type="System.Int32" />
203       </Parameters>
204       <Docs>
205         <param name="i">The column index (zero-based).</param>
206         <summary>Gets the name of the SQL data type for the given column.</summary>
207         <returns>The name of a SQL data type, such as "text."</returns>
208         <remarks>For Sqlite2 databases, "text" is always the return value.  For Sqlite3, the return value may be the data type used to create the column.</remarks>
209       </Docs>
210       <AssemblyInfo>
211         <AssemblyVersion>2.0.0.0</AssemblyVersion>
212       </AssemblyInfo>
213     </Member>
214     <Member MemberName="GetDateTime">
215       <MemberSignature Language="C#" Value="public override DateTime GetDateTime (int i);" />
216       <MemberType>Method</MemberType>
217       <ReturnValue>
218         <ReturnType>System.DateTime</ReturnType>
219       </ReturnValue>
220       <Parameters>
221         <Parameter Name="i" Type="System.Int32" />
222       </Parameters>
223       <Docs>
224         <param name="i">The column index (zero-based).</param>
225         <summary>Get the value in a column converted to a DateTime.</summary>
226         <returns>The DateTime value in the <paramref name="i" />th column.</returns>
227         <remarks>In Sqlite 3 databases, if the column is typed as DATE or DATETIME and an integer value was put into the field, then SqliteClient will convert the integer value to a DateTime struct using <see cref="M:System.DateTime.FromFileTime(int)" />.  For Sqlite 2 and 3, if a string value was put into the field, then the string will be converted to a DateTime using <see cref="M:System.DateTime.Parse(string)" />.  Any other data type in the column may throw an exception.</remarks>
228       </Docs>
229       <AssemblyInfo>
230         <AssemblyVersion>2.0.0.0</AssemblyVersion>
231       </AssemblyInfo>
232     </Member>
233     <Member MemberName="GetDecimal">
234       <MemberSignature Language="C#" Value="public override decimal GetDecimal (int i);" />
235       <MemberType>Method</MemberType>
236       <ReturnValue>
237         <ReturnType>System.Decimal</ReturnType>
238       </ReturnValue>
239       <Parameters>
240         <Parameter Name="i" Type="System.Int32" />
241       </Parameters>
242       <Docs>
243         <param name="i">The column index (zero-based).</param>
244         <summary>Get the value in a column converted to a Decimal.</summary>
245         <returns>The decimal value in the <paramref name="i" />th column.</returns>
246         <remarks>None.</remarks>
247       </Docs>
248       <AssemblyInfo>
249         <AssemblyVersion>2.0.0.0</AssemblyVersion>
250       </AssemblyInfo>
251     </Member>
252     <Member MemberName="GetDouble">
253       <MemberSignature Language="C#" Value="public override double GetDouble (int i);" />
254       <MemberType>Method</MemberType>
255       <ReturnValue>
256         <ReturnType>System.Double</ReturnType>
257       </ReturnValue>
258       <Parameters>
259         <Parameter Name="i" Type="System.Int32" />
260       </Parameters>
261       <Docs>
262         <param name="i">The column index (zero-based).</param>
263         <summary>Get the value in a column converted to a double.</summary>
264         <returns>The double value in the <paramref name="i" />th column.</returns>
265         <remarks>None.</remarks>
266       </Docs>
267       <AssemblyInfo>
268         <AssemblyVersion>2.0.0.0</AssemblyVersion>
269       </AssemblyInfo>
270     </Member>
271     <Member MemberName="GetEnumerator">
272       <MemberSignature Language="C#" Value="public override System.Collections.IEnumerator GetEnumerator ();" />
273       <MemberType>Method</MemberType>
274       <AssemblyInfo>
275         <AssemblyVersion>2.0.0.0</AssemblyVersion>
276       </AssemblyInfo>
277       <ReturnValue>
278         <ReturnType>System.Collections.IEnumerator</ReturnType>
279       </ReturnValue>
280       <Parameters />
281       <Docs>
282         <summary>To be added.</summary>
283         <returns>To be added.</returns>
284         <remarks>To be added.</remarks>
285       </Docs>
286     </Member>
287     <Member MemberName="GetFieldType">
288       <MemberSignature Language="C#" Value="public override Type GetFieldType (int i);" />
289       <MemberType>Method</MemberType>
290       <ReturnValue>
291         <ReturnType>System.Type</ReturnType>
292       </ReturnValue>
293       <Parameters>
294         <Parameter Name="i" Type="System.Int32" />
295       </Parameters>
296       <Docs>
297         <param name="i">The column index (zero-based).</param>
298         <summary>Gets a Type representing the type of data in the field.</summary>
299         <returns>Gets the type of data in the <paramref name="i" />th column for the current row of the DataReader.</returns>
300         <remarks>
301           <para>If the DataReader is positioned before the first row and a row of data is available, GetFieldType returns the data type for the first row.  If no rows of data are available, GetFieldType returns <see cref="T:System.String" />.</para>
302           <para>If the <paramref name="i" />th column contains NULL, then GetFieldType returns <see cref="T:System.String" />.</para>
303         </remarks>
304       </Docs>
305       <AssemblyInfo>
306         <AssemblyVersion>2.0.0.0</AssemblyVersion>
307       </AssemblyInfo>
308     </Member>
309     <Member MemberName="GetFloat">
310       <MemberSignature Language="C#" Value="public override float GetFloat (int i);" />
311       <MemberType>Method</MemberType>
312       <ReturnValue>
313         <ReturnType>System.Single</ReturnType>
314       </ReturnValue>
315       <Parameters>
316         <Parameter Name="i" Type="System.Int32" />
317       </Parameters>
318       <Docs>
319         <param name="i">The column index (zero-based).</param>
320         <summary>Get the value in a column converted to a float.</summary>
321         <returns>The float value in the <paramref name="i" />th column.</returns>
322         <remarks>None.</remarks>
323       </Docs>
324       <AssemblyInfo>
325         <AssemblyVersion>2.0.0.0</AssemblyVersion>
326       </AssemblyInfo>
327     </Member>
328     <Member MemberName="GetGuid">
329       <MemberSignature Language="C#" Value="public override Guid GetGuid (int i);" />
330       <MemberType>Method</MemberType>
331       <ReturnValue>
332         <ReturnType>System.Guid</ReturnType>
333       </ReturnValue>
334       <Parameters>
335         <Parameter Name="i" Type="System.Int32" />
336       </Parameters>
337       <Docs>
338         <param name="i">The column index (zero-based).</param>
339         <summary>Get the value in a column converted to a GUID.</summary>
340         <returns>The GUID value in the <paramref name="i" />th column.</returns>
341         <remarks>None.</remarks>
342       </Docs>
343       <AssemblyInfo>
344         <AssemblyVersion>2.0.0.0</AssemblyVersion>
345       </AssemblyInfo>
346     </Member>
347     <Member MemberName="GetInt16">
348       <MemberSignature Language="C#" Value="public override short GetInt16 (int i);" />
349       <MemberType>Method</MemberType>
350       <ReturnValue>
351         <ReturnType>System.Int16</ReturnType>
352       </ReturnValue>
353       <Parameters>
354         <Parameter Name="i" Type="System.Int32" />
355       </Parameters>
356       <Docs>
357         <param name="i">The column index (zero-based).</param>
358         <summary>Get the value in a column converted to a short.</summary>
359         <returns>The short value in the <paramref name="i" />th column.</returns>
360         <remarks>None.</remarks>
361       </Docs>
362       <AssemblyInfo>
363         <AssemblyVersion>2.0.0.0</AssemblyVersion>
364       </AssemblyInfo>
365     </Member>
366     <Member MemberName="GetInt32">
367       <MemberSignature Language="C#" Value="public override int GetInt32 (int i);" />
368       <MemberType>Method</MemberType>
369       <ReturnValue>
370         <ReturnType>System.Int32</ReturnType>
371       </ReturnValue>
372       <Parameters>
373         <Parameter Name="i" Type="System.Int32" />
374       </Parameters>
375       <Docs>
376         <param name="i">The column index (zero-based).</param>
377         <summary>Get the value in a column converted to an int.</summary>
378         <returns>The int value in the <paramref name="i" />th column.</returns>
379         <remarks>None.</remarks>
380       </Docs>
381       <AssemblyInfo>
382         <AssemblyVersion>2.0.0.0</AssemblyVersion>
383       </AssemblyInfo>
384     </Member>
385     <Member MemberName="GetInt64">
386       <MemberSignature Language="C#" Value="public override long GetInt64 (int i);" />
387       <MemberType>Method</MemberType>
388       <ReturnValue>
389         <ReturnType>System.Int64</ReturnType>
390       </ReturnValue>
391       <Parameters>
392         <Parameter Name="i" Type="System.Int32" />
393       </Parameters>
394       <Docs>
395         <param name="i">The column index (zero-based).</param>
396         <summary>Get the value in a column converted to a long.</summary>
397         <returns>The long value in the <paramref name="i" />th column.</returns>
398         <remarks>None.</remarks>
399       </Docs>
400       <AssemblyInfo>
401         <AssemblyVersion>2.0.0.0</AssemblyVersion>
402       </AssemblyInfo>
403     </Member>
404     <Member MemberName="GetName">
405       <MemberSignature Language="C#" Value="public override string GetName (int i);" />
406       <MemberType>Method</MemberType>
407       <ReturnValue>
408         <ReturnType>System.String</ReturnType>
409       </ReturnValue>
410       <Parameters>
411         <Parameter Name="i" Type="System.Int32" />
412       </Parameters>
413       <Docs>
414         <param name="i">The column index (zero-based).</param>
415         <summary>Gets the name of a column.</summary>
416         <returns>The name of the column, as given in the SQL query or the source table.</returns>
417         <remarks>None.</remarks>
418       </Docs>
419       <AssemblyInfo>
420         <AssemblyVersion>2.0.0.0</AssemblyVersion>
421       </AssemblyInfo>
422     </Member>
423     <Member MemberName="GetOrdinal">
424       <MemberSignature Language="C#" Value="public override int GetOrdinal (string name);" />
425       <MemberType>Method</MemberType>
426       <ReturnValue>
427         <ReturnType>System.Int32</ReturnType>
428       </ReturnValue>
429       <Parameters>
430         <Parameter Name="name" Type="System.String" />
431       </Parameters>
432       <Docs>
433         <param name="name">The name of a column.</param>
434         <summary>Gets the index of a column by name.</summary>
435         <returns>The index of the column.</returns>
436         <remarks>This method throws an ArgumentException if the name is not the name of a column.  The name is treated case-insensitively.</remarks>
437       </Docs>
438       <AssemblyInfo>
439         <AssemblyVersion>2.0.0.0</AssemblyVersion>
440       </AssemblyInfo>
441     </Member>
442     <Member MemberName="GetSchemaTable">
443       <MemberSignature Language="C#" Value="public override System.Data.DataTable GetSchemaTable ();" />
444       <MemberType>Method</MemberType>
445       <ReturnValue>
446         <ReturnType>System.Data.DataTable</ReturnType>
447       </ReturnValue>
448       <Parameters />
449       <Docs>
450         <summary>To be added.</summary>
451         <returns>To be added.</returns>
452         <remarks>To be added.</remarks>
453       </Docs>
454       <AssemblyInfo>
455         <AssemblyVersion>2.0.0.0</AssemblyVersion>
456       </AssemblyInfo>
457     </Member>
458     <Member MemberName="GetString">
459       <MemberSignature Language="C#" Value="public override string GetString (int i);" />
460       <MemberType>Method</MemberType>
461       <ReturnValue>
462         <ReturnType>System.String</ReturnType>
463       </ReturnValue>
464       <Parameters>
465         <Parameter Name="i" Type="System.Int32" />
466       </Parameters>
467       <Docs>
468         <param name="i">The column index (zero-based).</param>
469         <summary>Gets the value in a column converted to a string.</summary>
470         <returns>The value in the <paramref name="i" />th column converted to a string.</returns>
471         <remarks>None.</remarks>
472       </Docs>
473       <AssemblyInfo>
474         <AssemblyVersion>2.0.0.0</AssemblyVersion>
475       </AssemblyInfo>
476     </Member>
477     <Member MemberName="GetValue">
478       <MemberSignature Language="C#" Value="public override object GetValue (int i);" />
479       <MemberType>Method</MemberType>
480       <ReturnValue>
481         <ReturnType>System.Object</ReturnType>
482       </ReturnValue>
483       <Parameters>
484         <Parameter Name="i" Type="System.Int32" />
485       </Parameters>
486       <Docs>
487         <param name="i">The column index (zero-based).</param>
488         <summary>Gets the value in the table by column index.</summary>
489         <returns>The value in the table at the given column and in the row the DataReader is currently positioned on.</returns>
490         <remarks>None.</remarks>
491       </Docs>
492       <AssemblyInfo>
493         <AssemblyVersion>2.0.0.0</AssemblyVersion>
494       </AssemblyInfo>
495     </Member>
496     <Member MemberName="GetValues">
497       <MemberSignature Language="C#" Value="public override int GetValues (object[] values);" />
498       <MemberType>Method</MemberType>
499       <ReturnValue>
500         <ReturnType>System.Int32</ReturnType>
501       </ReturnValue>
502       <Parameters>
503         <Parameter Name="values" Type="System.Object[]" />
504       </Parameters>
505       <Docs>
506         <param name="values">An array, usually the size of <see cref="P:Mono.Data.SqliteClient.SqliteDataReader.FieldCount" />.</param>
507         <summary>Fills an array with values in the current row of the table.</summary>
508         <returns>The number of values put into <paramref name="values" />, which is the minimum of the array's length and FieldCount.</returns>
509         <remarks>
510           <para>
511             <paramref name="values" /> is filled with the values in the current row of the table, starting with the first column and going to the last column or until the end of <paramref name="values" />.</para>
512           <para>Unusually, null values in the database are put into <paramref name="values" /> as <see cref="P:System.DBNull.Value" />.</para>
513         </remarks>
514       </Docs>
515       <AssemblyInfo>
516         <AssemblyVersion>2.0.0.0</AssemblyVersion>
517       </AssemblyInfo>
518     </Member>
519     <Member MemberName="HasRows">
520       <MemberSignature Language="C#" Value="public override bool HasRows { get; }" />
521       <MemberType>Property</MemberType>
522       <AssemblyInfo>
523         <AssemblyVersion>2.0.0.0</AssemblyVersion>
524       </AssemblyInfo>
525       <ReturnValue>
526         <ReturnType>System.Boolean</ReturnType>
527       </ReturnValue>
528       <Docs>
529         <summary>To be added.</summary>
530         <value>To be added.</value>
531         <remarks>To be added.</remarks>
532       </Docs>
533     </Member>
534     <Member MemberName="IsClosed">
535       <MemberSignature Language="C#" Value="public override bool IsClosed { get; }" />
536       <MemberType>Property</MemberType>
537       <ReturnValue>
538         <ReturnType>System.Boolean</ReturnType>
539       </ReturnValue>
540       <Docs>
541         <summary>Gets whether the DataReader has been closed.</summary>
542         <value>
543           <see langword="true" /> if Close or Dispose has been called on the DataReader.</value>
544         <remarks>None.</remarks>
545       </Docs>
546       <AssemblyInfo>
547         <AssemblyVersion>2.0.0.0</AssemblyVersion>
548       </AssemblyInfo>
549     </Member>
550     <Member MemberName="IsDBNull">
551       <MemberSignature Language="C#" Value="public override bool IsDBNull (int i);" />
552       <MemberType>Method</MemberType>
553       <ReturnValue>
554         <ReturnType>System.Boolean</ReturnType>
555       </ReturnValue>
556       <Parameters>
557         <Parameter Name="i" Type="System.Int32" />
558       </Parameters>
559       <Docs>
560         <param name="i">The column index (zero-based).</param>
561         <summary>Returns whether the value in the given column was null in the database.</summary>
562         <returns>Whether the value of the field in the database was null.</returns>
563         <remarks>None.</remarks>
564       </Docs>
565       <AssemblyInfo>
566         <AssemblyVersion>2.0.0.0</AssemblyVersion>
567       </AssemblyInfo>
568     </Member>
569     <Member MemberName="Item">
570       <MemberSignature Language="C#" Value="public override object this[int i] { get; }" />
571       <MemberType>Property</MemberType>
572       <ReturnValue>
573         <ReturnType>System.Object</ReturnType>
574       </ReturnValue>
575       <Parameters>
576         <Parameter Name="i" Type="System.Int32" />
577       </Parameters>
578       <Docs>
579         <param name="i">The column to retrieve (zero-based).</param>
580         <summary>Gets the value in the table by column index.</summary>
581         <value>The value in the table at the given column and in the row the DataReader is currently positioned on.</value>
582         <remarks>None.</remarks>
583       </Docs>
584       <AssemblyInfo>
585         <AssemblyVersion>2.0.0.0</AssemblyVersion>
586       </AssemblyInfo>
587     </Member>
588     <Member MemberName="Item">
589       <MemberSignature Language="C#" Value="public override object this[string name] { get; }" />
590       <MemberType>Property</MemberType>
591       <ReturnValue>
592         <ReturnType>System.Object</ReturnType>
593       </ReturnValue>
594       <Parameters>
595         <Parameter Name="name" Type="System.String" />
596       </Parameters>
597       <Docs>
598         <param name="name">The name of the column, as given in the SQL query.</param>
599         <summary>Gets the value in the table by column name.</summary>
600         <value>The value in the table at the given column and in the row the DataReader is currently positioned on.</value>
601         <remarks>None.</remarks>
602       </Docs>
603       <AssemblyInfo>
604         <AssemblyVersion>2.0.0.0</AssemblyVersion>
605       </AssemblyInfo>
606     </Member>
607     <Member MemberName="NextResult">
608       <MemberSignature Language="C#" Value="public override bool NextResult ();" />
609       <MemberType>Method</MemberType>
610       <ReturnValue>
611         <ReturnType>System.Boolean</ReturnType>
612       </ReturnValue>
613       <Parameters />
614       <Docs>
615         <summary>This method should not currently be used.</summary>
616         <returns>N/A.</returns>
617         <remarks>This method currently has the same behavior of Read(), but its behavior will be changed in a future release to match the behavior of other data adapters.</remarks>
618       </Docs>
619       <AssemblyInfo>
620         <AssemblyVersion>2.0.0.0</AssemblyVersion>
621       </AssemblyInfo>
622     </Member>
623     <Member MemberName="Read">
624       <MemberSignature Language="C#" Value="public override bool Read ();" />
625       <MemberType>Method</MemberType>
626       <ReturnValue>
627         <ReturnType>System.Boolean</ReturnType>
628       </ReturnValue>
629       <Parameters />
630       <Docs>
631         <summary>Positions the reader on the next row in the table.</summary>
632         <returns>
633           <see langword="true" /> if the move to the next row was successful, i.e. if another row existed in the table; <see langword="false" /> otherwise.</returns>
634         <remarks>None.</remarks>
635       </Docs>
636       <AssemblyInfo>
637         <AssemblyVersion>2.0.0.0</AssemblyVersion>
638       </AssemblyInfo>
639     </Member>
640     <Member MemberName="RecordsAffected">
641       <MemberSignature Language="C#" Value="public override int RecordsAffected { get; }" />
642       <MemberType>Property</MemberType>
643       <ReturnValue>
644         <ReturnType>System.Int32</ReturnType>
645       </ReturnValue>
646       <Docs>
647         <summary>Gets the number of rows in the source table modified by the query.</summary>
648         <value>The number of rows in the source table modified by the query.</value>
649         <remarks>None.</remarks>
650       </Docs>
651       <AssemblyInfo>
652         <AssemblyVersion>2.0.0.0</AssemblyVersion>
653       </AssemblyInfo>
654     </Member>
655     <Member MemberName="VisibleFieldCount">
656       <MemberSignature Language="C#" Value="public override int VisibleFieldCount { get; }" />
657       <MemberType>Property</MemberType>
658       <AssemblyInfo>
659         <AssemblyVersion>2.0.0.0</AssemblyVersion>
660       </AssemblyInfo>
661       <ReturnValue>
662         <ReturnType>System.Int32</ReturnType>
663       </ReturnValue>
664       <Docs>
665         <summary>To be added.</summary>
666         <value>To be added.</value>
667         <remarks>To be added.</remarks>
668       </Docs>
669     </Member>
670   </Members>
671 </Type>