Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
260 lines (232 sloc) 14.5 KB
<Type Name="OidEnumerator" FullName="System.Security.Cryptography.OidEnumerator">
<TypeSignature Language="C#" Value="public sealed class OidEnumerator : System.Collections.IEnumerator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit OidEnumerator extends System.Object implements class System.Collections.IEnumerator" />
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.OidEnumerator" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class OidEnumerator&#xA;Implements IEnumerator" />
<TypeSignature Language="C++ CLI" Value="public ref class OidEnumerator sealed : System::Collections::IEnumerator" />
<TypeSignature Language="F#" Value="type OidEnumerator = class&#xA; interface IEnumerator" />
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography.Encoding</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.IEnumerator</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides the ability to navigate through an <see cref="T:System.Security.Cryptography.OidCollection" /> object. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class implements the <xref:System.Collections.IEnumerator> interface.
## Examples
The following code example shows how to use the <xref:System.Security.Cryptography.OidEnumerator> class.
[!code-cpp[Cryptography.Oid#1](~/samples/snippets/cpp/VS_Snippets_CLR/Cryptography.Oid/CPP/cryptography.oid.cpp#1)]
[!code-csharp[Cryptography.Oid#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.Oid/CS/cryptography.oid.cs#1)]
[!code-vb[Cryptography.Oid#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.Oid/VB/cryptography.oid.vb#1)]
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Current">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.Oid Current { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.Oid Current" />
<MemberSignature Language="DocId" Value="P:System.Security.Cryptography.OidEnumerator.Current" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Current As Oid" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Security::Cryptography::Oid ^ Current { System::Security::Cryptography::Oid ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Current : System.Security.Cryptography.Oid" Usage="System.Security.Cryptography.OidEnumerator.Current" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography.Encoding</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.Oid</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current <see cref="T:System.Security.Cryptography.Oid" /> object in an <see cref="T:System.Security.Cryptography.OidCollection" /> object.</summary>
<value>The current <see cref="T:System.Security.Cryptography.Oid" /> object in the collection.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
After an enumerator is created, the <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> method must be called to advance the enumerator to the first element of the collection before reading the value of the <xref:System.Security.Cryptography.OidEnumerator.Current%2A> property; otherwise, <xref:System.Security.Cryptography.OidEnumerator.Current%2A> returns `null` or throws an exception.
<xref:System.Security.Cryptography.OidEnumerator.Current%2A> also returns `null` or throws an exception if the last call to <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> returns `false`, which indicates that the end of the collection has been reached.
<xref:System.Security.Cryptography.OidEnumerator.Current%2A> does not move the position of the enumerator, and consecutive calls to <xref:System.Security.Cryptography.OidEnumerator.Current%2A> return the same object, until <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> is called.
## Examples
The following code example shows how to use the <xref:System.Security.Cryptography.OidEnumerator> class.
[!code-cpp[Cryptography.Oid#1](~/samples/snippets/cpp/VS_Snippets_CLR/Cryptography.Oid/CPP/cryptography.oid.cpp#1)]
[!code-csharp[Cryptography.Oid#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.Oid/CS/cryptography.oid.cs#1)]
[!code-vb[Cryptography.Oid#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.Oid/VB/cryptography.oid.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MoveNext">
<MemberSignature Language="C#" Value="public bool MoveNext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool MoveNext() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.OidEnumerator.MoveNext" />
<MemberSignature Language="VB.NET" Value="Public Function MoveNext () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual bool MoveNext();" />
<MemberSignature Language="F#" Value="abstract member MoveNext : unit -&gt; bool&#xA;override this.MoveNext : unit -&gt; bool" Usage="oidEnumerator.MoveNext " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerator.MoveNext</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography.Encoding</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Advances to the next <see cref="T:System.Security.Cryptography.Oid" /> object in an <see cref="T:System.Security.Cryptography.OidCollection" /> object.</summary>
<returns>
<see langword="true" />, if the enumerator was successfully advanced to the next element; <see langword="false" />, if the enumerator has passed the end of the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
After an enumerator is created, it is positioned before the first element of the collection, and the first call to the <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> method moves the enumerator over the first element of the collection. Subsequent calls to <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> advances the enumerator past subsequent items in the collection.
After the end of the collection is passed, calls to <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> return `false`.
An enumerator is valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator becomes invalid and the next call to <xref:System.Security.Cryptography.OidEnumerator.MoveNext%2A> throws an <xref:System.InvalidOperationException>.
## Examples
The following code example shows how to use the <xref:System.Security.Cryptography.OidEnumerator> class.
[!code-cpp[Cryptography.Oid#1](~/samples/snippets/cpp/VS_Snippets_CLR/Cryptography.Oid/CPP/cryptography.oid.cpp#1)]
[!code-csharp[Cryptography.Oid#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.Oid/CS/cryptography.oid.cs#1)]
[!code-vb[Cryptography.Oid#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.Oid/VB/cryptography.oid.vb#1)]
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created.</exception>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Reset() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.OidEnumerator.Reset" />
<MemberSignature Language="VB.NET" Value="Public Sub Reset ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Reset();" />
<MemberSignature Language="F#" Value="abstract member Reset : unit -&gt; unit&#xA;override this.Reset : unit -&gt; unit" Usage="oidEnumerator.Reset " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerator.Reset</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography.Encoding</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Sets an enumerator to its initial position.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The initial position of an enumerator is before the first element in the <xref:System.Security.Cryptography.OidCollection> object. 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 becomes invalid and the next call to the <xref:System.Security.Cryptography.OidEnumerator.Reset%2A> method throws an <xref:System.InvalidOperationException>.
## Examples
The following code example shows how to use the <xref:System.Security.Cryptography.OidEnumerator> class.
[!code-cpp[Cryptography.Oid#1](~/samples/snippets/cpp/VS_Snippets_CLR/Cryptography.Oid/CPP/cryptography.oid.cpp#1)]
[!code-csharp[Cryptography.Oid#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.Oid/CS/cryptography.oid.cs#1)]
[!code-vb[Cryptography.Oid#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.Oid/VB/cryptography.oid.vb#1)]
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created.</exception>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Current">
<MemberSignature Language="C#" Value="object System.Collections.IEnumerator.Current { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object System.Collections.IEnumerator.Current" />
<MemberSignature Language="DocId" Value="P:System.Security.Cryptography.OidEnumerator.System#Collections#IEnumerator#Current" />
<MemberSignature Language="VB.NET" Value=" ReadOnly Property Current As Object Implements IEnumerator.Current" />
<MemberSignature Language="C++ CLI" Value="property System::Object ^ System::Collections::IEnumerator::Current { System::Object ^ get(); };" />
<MemberSignature Language="F#" Usage="System.Collections.IEnumerator.Current" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Collections.IEnumerator.Current</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography.Encoding</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current <see cref="T:System.Security.Cryptography.Oid" /> object in an <see cref="T:System.Security.Cryptography.OidCollection" /> object.</summary>
<value>The current <see cref="T:System.Security.Cryptography.Oid" /> object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.