1 <Type Name="SqliteDataReader" FullName="Mono.Data.SqliteClient.SqliteDataReader">
2 <TypeSignature Language="C#" Value="public class SqliteDataReader : System.Data.Common.DbDataReader" />
4 <AssemblyName>Mono.Data.SqliteClient</AssemblyName>
5 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
6 <AssemblyVersion>2.0.0.0</AssemblyVersion>
9 <BaseTypeName>System.Data.Common.DbDataReader</BaseTypeName>
14 <summary>The DataReader represents a table of results returned from a query.</summary>
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>
21 <Member MemberName="Close">
22 <MemberSignature Language="C#" Value="public override void Close ();" />
23 <MemberType>Method</MemberType>
25 <ReturnType>System.Void</ReturnType>
29 <summary>Closes the DataReader.</summary>
30 <remarks>None.</remarks>
33 <AssemblyVersion>2.0.0.0</AssemblyVersion>
36 <Member MemberName="Depth">
37 <MemberSignature Language="C#" Value="public override int Depth { get; }" />
38 <MemberType>Property</MemberType>
40 <ReturnType>System.Int32</ReturnType>
43 <summary>Returns zero.</summary>
45 <remarks>This method is not currently used.</remarks>
48 <AssemblyVersion>2.0.0.0</AssemblyVersion>
51 <Member MemberName="Dispose">
52 <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
53 <MemberType>Method</MemberType>
55 <AssemblyVersion>2.0.0.0</AssemblyVersion>
58 <ReturnType>System.Void</ReturnType>
61 <Parameter Name="disposing" Type="System.Boolean" />
64 <param name="disposing">To be added.</param>
65 <summary>To be added.</summary>
66 <remarks>To be added.</remarks>
69 <Member MemberName="FieldCount">
70 <MemberSignature Language="C#" Value="public override int FieldCount { get; }" />
71 <MemberType>Property</MemberType>
73 <ReturnType>System.Int32</ReturnType>
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>
81 <AssemblyVersion>2.0.0.0</AssemblyVersion>
84 <Member MemberName="GetBoolean">
85 <MemberSignature Language="C#" Value="public override bool GetBoolean (int i);" />
86 <MemberType>Method</MemberType>
88 <ReturnType>System.Boolean</ReturnType>
91 <Parameter Name="i" Type="System.Int32" />
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>
100 <AssemblyVersion>2.0.0.0</AssemblyVersion>
103 <Member MemberName="GetByte">
104 <MemberSignature Language="C#" Value="public override byte GetByte (int i);" />
105 <MemberType>Method</MemberType>
107 <ReturnType>System.Byte</ReturnType>
110 <Parameter Name="i" Type="System.Int32" />
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>
119 <AssemblyVersion>2.0.0.0</AssemblyVersion>
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>
126 <ReturnType>System.Int64</ReturnType>
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" />
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>
146 <AssemblyVersion>2.0.0.0</AssemblyVersion>
149 <Member MemberName="GetChar">
150 <MemberSignature Language="C#" Value="public override char GetChar (int i);" />
151 <MemberType>Method</MemberType>
153 <ReturnType>System.Char</ReturnType>
156 <Parameter Name="i" Type="System.Int32" />
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>
165 <AssemblyVersion>2.0.0.0</AssemblyVersion>
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>
172 <ReturnType>System.Int64</ReturnType>
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" />
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>
192 <AssemblyVersion>2.0.0.0</AssemblyVersion>
195 <Member MemberName="GetDataTypeName">
196 <MemberSignature Language="C#" Value="public override string GetDataTypeName (int i);" />
197 <MemberType>Method</MemberType>
199 <ReturnType>System.String</ReturnType>
202 <Parameter Name="i" Type="System.Int32" />
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>
211 <AssemblyVersion>2.0.0.0</AssemblyVersion>
214 <Member MemberName="GetDateTime">
215 <MemberSignature Language="C#" Value="public override DateTime GetDateTime (int i);" />
216 <MemberType>Method</MemberType>
218 <ReturnType>System.DateTime</ReturnType>
221 <Parameter Name="i" Type="System.Int32" />
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>
230 <AssemblyVersion>2.0.0.0</AssemblyVersion>
233 <Member MemberName="GetDecimal">
234 <MemberSignature Language="C#" Value="public override decimal GetDecimal (int i);" />
235 <MemberType>Method</MemberType>
237 <ReturnType>System.Decimal</ReturnType>
240 <Parameter Name="i" Type="System.Int32" />
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>
249 <AssemblyVersion>2.0.0.0</AssemblyVersion>
252 <Member MemberName="GetDouble">
253 <MemberSignature Language="C#" Value="public override double GetDouble (int i);" />
254 <MemberType>Method</MemberType>
256 <ReturnType>System.Double</ReturnType>
259 <Parameter Name="i" Type="System.Int32" />
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>
268 <AssemblyVersion>2.0.0.0</AssemblyVersion>
271 <Member MemberName="GetEnumerator">
272 <MemberSignature Language="C#" Value="public override System.Collections.IEnumerator GetEnumerator ();" />
273 <MemberType>Method</MemberType>
275 <AssemblyVersion>2.0.0.0</AssemblyVersion>
278 <ReturnType>System.Collections.IEnumerator</ReturnType>
282 <summary>To be added.</summary>
283 <returns>To be added.</returns>
284 <remarks>To be added.</remarks>
287 <Member MemberName="GetFieldType">
288 <MemberSignature Language="C#" Value="public override Type GetFieldType (int i);" />
289 <MemberType>Method</MemberType>
291 <ReturnType>System.Type</ReturnType>
294 <Parameter Name="i" Type="System.Int32" />
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>
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>
306 <AssemblyVersion>2.0.0.0</AssemblyVersion>
309 <Member MemberName="GetFloat">
310 <MemberSignature Language="C#" Value="public override float GetFloat (int i);" />
311 <MemberType>Method</MemberType>
313 <ReturnType>System.Single</ReturnType>
316 <Parameter Name="i" Type="System.Int32" />
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>
325 <AssemblyVersion>2.0.0.0</AssemblyVersion>
328 <Member MemberName="GetGuid">
329 <MemberSignature Language="C#" Value="public override Guid GetGuid (int i);" />
330 <MemberType>Method</MemberType>
332 <ReturnType>System.Guid</ReturnType>
335 <Parameter Name="i" Type="System.Int32" />
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>
344 <AssemblyVersion>2.0.0.0</AssemblyVersion>
347 <Member MemberName="GetInt16">
348 <MemberSignature Language="C#" Value="public override short GetInt16 (int i);" />
349 <MemberType>Method</MemberType>
351 <ReturnType>System.Int16</ReturnType>
354 <Parameter Name="i" Type="System.Int32" />
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>
363 <AssemblyVersion>2.0.0.0</AssemblyVersion>
366 <Member MemberName="GetInt32">
367 <MemberSignature Language="C#" Value="public override int GetInt32 (int i);" />
368 <MemberType>Method</MemberType>
370 <ReturnType>System.Int32</ReturnType>
373 <Parameter Name="i" Type="System.Int32" />
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>
382 <AssemblyVersion>2.0.0.0</AssemblyVersion>
385 <Member MemberName="GetInt64">
386 <MemberSignature Language="C#" Value="public override long GetInt64 (int i);" />
387 <MemberType>Method</MemberType>
389 <ReturnType>System.Int64</ReturnType>
392 <Parameter Name="i" Type="System.Int32" />
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>
401 <AssemblyVersion>2.0.0.0</AssemblyVersion>
404 <Member MemberName="GetName">
405 <MemberSignature Language="C#" Value="public override string GetName (int i);" />
406 <MemberType>Method</MemberType>
408 <ReturnType>System.String</ReturnType>
411 <Parameter Name="i" Type="System.Int32" />
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>
420 <AssemblyVersion>2.0.0.0</AssemblyVersion>
423 <Member MemberName="GetOrdinal">
424 <MemberSignature Language="C#" Value="public override int GetOrdinal (string name);" />
425 <MemberType>Method</MemberType>
427 <ReturnType>System.Int32</ReturnType>
430 <Parameter Name="name" Type="System.String" />
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>
439 <AssemblyVersion>2.0.0.0</AssemblyVersion>
442 <Member MemberName="GetSchemaTable">
443 <MemberSignature Language="C#" Value="public override System.Data.DataTable GetSchemaTable ();" />
444 <MemberType>Method</MemberType>
446 <ReturnType>System.Data.DataTable</ReturnType>
450 <summary>To be added.</summary>
451 <returns>To be added.</returns>
452 <remarks>To be added.</remarks>
455 <AssemblyVersion>2.0.0.0</AssemblyVersion>
458 <Member MemberName="GetString">
459 <MemberSignature Language="C#" Value="public override string GetString (int i);" />
460 <MemberType>Method</MemberType>
462 <ReturnType>System.String</ReturnType>
465 <Parameter Name="i" Type="System.Int32" />
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>
474 <AssemblyVersion>2.0.0.0</AssemblyVersion>
477 <Member MemberName="GetValue">
478 <MemberSignature Language="C#" Value="public override object GetValue (int i);" />
479 <MemberType>Method</MemberType>
481 <ReturnType>System.Object</ReturnType>
484 <Parameter Name="i" Type="System.Int32" />
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>
493 <AssemblyVersion>2.0.0.0</AssemblyVersion>
496 <Member MemberName="GetValues">
497 <MemberSignature Language="C#" Value="public override int GetValues (object[] values);" />
498 <MemberType>Method</MemberType>
500 <ReturnType>System.Int32</ReturnType>
503 <Parameter Name="values" Type="System.Object[]" />
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>
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>
516 <AssemblyVersion>2.0.0.0</AssemblyVersion>
519 <Member MemberName="HasRows">
520 <MemberSignature Language="C#" Value="public override bool HasRows { get; }" />
521 <MemberType>Property</MemberType>
523 <AssemblyVersion>2.0.0.0</AssemblyVersion>
526 <ReturnType>System.Boolean</ReturnType>
529 <summary>To be added.</summary>
530 <value>To be added.</value>
531 <remarks>To be added.</remarks>
534 <Member MemberName="IsClosed">
535 <MemberSignature Language="C#" Value="public override bool IsClosed { get; }" />
536 <MemberType>Property</MemberType>
538 <ReturnType>System.Boolean</ReturnType>
541 <summary>Gets whether the DataReader has been closed.</summary>
543 <see langword="true" /> if Close or Dispose has been called on the DataReader.</value>
544 <remarks>None.</remarks>
547 <AssemblyVersion>2.0.0.0</AssemblyVersion>
550 <Member MemberName="IsDBNull">
551 <MemberSignature Language="C#" Value="public override bool IsDBNull (int i);" />
552 <MemberType>Method</MemberType>
554 <ReturnType>System.Boolean</ReturnType>
557 <Parameter Name="i" Type="System.Int32" />
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>
566 <AssemblyVersion>2.0.0.0</AssemblyVersion>
569 <Member MemberName="Item">
570 <MemberSignature Language="C#" Value="public override object this[int i] { get; }" />
571 <MemberType>Property</MemberType>
573 <ReturnType>System.Object</ReturnType>
576 <Parameter Name="i" Type="System.Int32" />
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>
585 <AssemblyVersion>2.0.0.0</AssemblyVersion>
588 <Member MemberName="Item">
589 <MemberSignature Language="C#" Value="public override object this[string name] { get; }" />
590 <MemberType>Property</MemberType>
592 <ReturnType>System.Object</ReturnType>
595 <Parameter Name="name" Type="System.String" />
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>
604 <AssemblyVersion>2.0.0.0</AssemblyVersion>
607 <Member MemberName="NextResult">
608 <MemberSignature Language="C#" Value="public override bool NextResult ();" />
609 <MemberType>Method</MemberType>
611 <ReturnType>System.Boolean</ReturnType>
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>
620 <AssemblyVersion>2.0.0.0</AssemblyVersion>
623 <Member MemberName="Read">
624 <MemberSignature Language="C#" Value="public override bool Read ();" />
625 <MemberType>Method</MemberType>
627 <ReturnType>System.Boolean</ReturnType>
631 <summary>Positions the reader on the next row in the table.</summary>
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>
637 <AssemblyVersion>2.0.0.0</AssemblyVersion>
640 <Member MemberName="RecordsAffected">
641 <MemberSignature Language="C#" Value="public override int RecordsAffected { get; }" />
642 <MemberType>Property</MemberType>
644 <ReturnType>System.Int32</ReturnType>
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>
652 <AssemblyVersion>2.0.0.0</AssemblyVersion>
655 <Member MemberName="VisibleFieldCount">
656 <MemberSignature Language="C#" Value="public override int VisibleFieldCount { get; }" />
657 <MemberType>Property</MemberType>
659 <AssemblyVersion>2.0.0.0</AssemblyVersion>
662 <ReturnType>System.Int32</ReturnType>
665 <summary>To be added.</summary>
666 <value>To be added.</value>
667 <remarks>To be added.</remarks>