mcs/class/System.Data/Documentation/en/System.Data.Common/DbEnumerator.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DbEnumerator" FullName="System.Data.Common.DbEnumerator">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class DbEnumerator : System.Collections.IEnumerator" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Object</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Collections.IEnumerator</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <remarks>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>The <see cref="T:System.Data.Common.DbEnumerator" /> class is implemented by a .NET Framework data provider to provide data binding support.</para>
  24       <para>By design, the <see cref="T:System.Data.Common.DbEnumerator" /> object is intended for use with only one resultset. For example, if you execute a batch statement containing two SQL SELECT statements that return different schemas, the second statement might not retun the entire schema. To avoid this situation, obtain a <see cref="T:System.Data.Common.DbEnumerator" /> for each resultset, and then call the NextResult method of a .NET Framework data provider DataReader object.</para>
  25     </remarks>
  26     <summary>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>Exposes the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method, which supports a simple iteration over a collection by a .NET Framework data provider.</para>
  29     </summary>
  30   </Docs>
  31   <Members>
  32     <Member MemberName=".ctor">
  33       <MemberSignature Language="C#" Value="public DbEnumerator (System.Data.IDataReader reader);" />
  34       <MemberType>Constructor</MemberType>
  35       <ReturnValue />
  36       <Parameters>
  37         <Parameter Name="reader" Type="System.Data.IDataReader" />
  38       </Parameters>
  39       <Docs>
  40         <remarks>To be added</remarks>
  41         <summary>
  42           <attribution license="cc4" from="Microsoft" modified="false" />
  43           <para>Initializes a new instance of the <see cref="T:System.Data.Common.DbEnumerator" /> class using the specified DataReader.</para>
  44         </summary>
  45         <param name="reader">
  46           <attribution license="cc4" from="Microsoft" modified="false" />The DataReader through which to iterate. </param>
  47       </Docs>
  48       <AssemblyInfo>
  49         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  50         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  51       </AssemblyInfo>
  52     </Member>
  53     <Member MemberName=".ctor">
  54       <MemberSignature Language="C#" Value="public DbEnumerator (System.Data.IDataReader reader, bool closeReader);" />
  55       <MemberType>Constructor</MemberType>
  56       <ReturnValue />
  57       <Parameters>
  58         <Parameter Name="reader" Type="System.Data.IDataReader" />
  59         <Parameter Name="closeReader" Type="System.Boolean" />
  60       </Parameters>
  61       <Docs>
  62         <remarks>To be added</remarks>
  63         <summary>
  64           <attribution license="cc4" from="Microsoft" modified="false" />
  65           <para>Initializes a new instance of the <see cref="T:System.Data.Common.DbEnumerator" /> class using the specified DataReader, and indicates whether to automatically close the DataReader after iterating through its data.</para>
  66         </summary>
  67         <param name="reader">
  68           <attribution license="cc4" from="Microsoft" modified="false" />The DataReader through which to iterate. </param>
  69         <param name="closeReader">
  70           <attribution license="cc4" from="Microsoft" modified="false" />true to automatically close the DataReader after iterating through its data; otherwise, false. </param>
  71       </Docs>
  72       <AssemblyInfo>
  73         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  74         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  75       </AssemblyInfo>
  76     </Member>
  77     <Member MemberName="Current">
  78       <MemberSignature Language="C#" Value="public object Current { get; }" />
  79       <MemberType>Property</MemberType>
  80       <ReturnValue>
  81         <ReturnType>System.Object</ReturnType>
  82       </ReturnValue>
  83       <Docs>
  84         <value>To be added: an object of type 'object'</value>
  85         <remarks>
  86           <attribution license="cc4" from="Microsoft" modified="false" />
  87           <para>After an enumerator is created or after a <see cref="M:System.Data.Common.DbEnumerator.Reset" />, <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> must be called to advance the enumerator to the first element of the collection before reading the value of <see cref="P:System.Data.Common.DbEnumerator.Current" />; otherwise, <see cref="P:System.Data.Common.DbEnumerator.Current" /> is undefined. <see cref="P:System.Data.Common.DbEnumerator.Current" /> also throws an exception if the last call to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> returned false, which indicates the end of the collection. <see cref="P:System.Data.Common.DbEnumerator.Current" /> does not move the position of the enumerator and consecutive calls to <see cref="P:System.Data.Common.DbEnumerator.Current" /> return the same object until either <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> or <see cref="M:System.Data.Common.DbEnumerator.Reset" /> is called. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irrecoverably invalidated and the next call to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> or <see cref="M:System.Data.Common.DbEnumerator.Reset" /> generates an <see cref="T:System.InvalidOperationException" />. If the collection is modified between <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> and <see cref="P:System.Data.Common.DbEnumerator.Current" />, <see cref="P:System.Data.Common.DbEnumerator.Current" /> returns the element to which it is set, even if the enumerator is already invalidated.</para>
  88         </remarks>
  89         <summary>
  90           <attribution license="cc4" from="Microsoft" modified="false" />
  91           <para>Gets the current element in the collection.</para>
  92         </summary>
  93       </Docs>
  94       <AssemblyInfo>
  95         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  96         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  97       </AssemblyInfo>
  98     </Member>
  99     <Member MemberName="MoveNext">
 100       <MemberSignature Language="C#" Value="public bool MoveNext ();" />
 101       <MemberType>Method</MemberType>
 102       <ReturnValue>
 103         <ReturnType>System.Boolean</ReturnType>
 104       </ReturnValue>
 105       <Parameters />
 106       <Docs>
 107         <returns>To be added: an object of type 'bool'</returns>
 108         <remarks>
 109           <attribution license="cc4" from="Microsoft" modified="false" />
 110           <para>After an enumerator is created or after a call to <see cref="M:System.Data.Common.DbEnumerator.Reset" />, an enumerator is positioned before the first element of the collection, and the first call to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> moves the enumerator over the first element of the collection. After the end of the collection is passed, subsequent calls to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> return false until <see cref="M:System.Data.Common.DbEnumerator.Reset" /> is called. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irrecoverably invalidated and the next call to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> or <see cref="M:System.Data.Common.DbEnumerator.Reset" /> throws an <see cref="T:System.InvalidOperationException" />.</para>
 111         </remarks>
 112         <summary>
 113           <attribution license="cc4" from="Microsoft" modified="false" />
 114           <para>Advances the enumerator to the next element of the collection.</para>
 115         </summary>
 116       </Docs>
 117       <AssemblyInfo>
 118         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 119         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 120       </AssemblyInfo>
 121     </Member>
 122     <Member MemberName="Reset">
 123       <MemberSignature Language="C#" Value="public void Reset ();" />
 124       <MemberType>Method</MemberType>
 125       <ReturnValue>
 126         <ReturnType>System.Void</ReturnType>
 127       </ReturnValue>
 128       <Parameters />
 129       <Docs>
 130         <remarks>
 131           <attribution license="cc4" from="Microsoft" modified="false" />
 132           <para>An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irrecoverably invalidated and the next call to <see cref="M:System.Data.Common.DbEnumerator.MoveNext" /> or <see cref="M:System.Data.Common.DbEnumerator.Reset" /> throws an <see cref="T:System.InvalidOperationException" />.</para>
 133         </remarks>
 134         <summary>
 135           <attribution license="cc4" from="Microsoft" modified="false" />
 136           <para>Sets the enumerator to its initial position, which is before the first element in the collection.</para>
 137         </summary>
 138       </Docs>
 139       <AssemblyInfo>
 140         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 141         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 142       </AssemblyInfo>
 143       <Attributes>
 144         <Attribute>
 145           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
 146         </Attribute>
 147       </Attributes>
 148     </Member>
 149   </Members>
 150 </Type>