mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

597
mcs/class/corlib/Documentation/en/System.Threading/AbandonedMutexException.xml Normal file
View File

File diff suppressed because it is too large Load Diff

98
mcs/class/corlib/Documentation/en/System.Threading/ApartmentState.xml Normal file
View File

@@ -0,0 +1,98 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ApartmentState" FullName="System.Threading.ApartmentState">
<TypeSignature Maintainer="auto" Language="C#" Value="public enum ApartmentState" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed ApartmentState extends System.Enum" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An apartment is a logical container within a process for objects sharing the same thread access requirements. All objects in the same apartment can receive calls from any thread in the apartment. The .NET Framework does not use apartments, and managed objects are responsible for using all shared resources in a thread-safe manner themselves.</para>
<para>Because COM classes use apartments, the common language runtime needs to create and initialize an apartment when calling a COM object in a COM interop situation. A managed thread can create and enter a single-threaded apartment (STA) that allows only one thread, or a multithreaded apartment (MTA) that contains one or more threads. You can control the type of apartment created by setting the <see cref="P:System.Threading.Thread.ApartmentState" /> property of the thread to one of the values of the <see cref="T:System.Threading.ApartmentState" /> enumeration. Because a given thread can only initialize a COM apartment once, you cannot change the apartment type after the first call to the unmanaged code.</para>
<para>For more information, see <see cref="T:System.Threading.Thread" />, <format type="text/html"><a href="DB425C20-4B2F-4433-BF96-76071C7881E5">[&lt;topic://cpconManagedUnmanagedThreading&gt;]</a></format>, and <format type="text/html"><a href="3ADA36E5-2390-4D70-B490-6AD8DE92F2FB">Advanced COM Interoperability</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the apartment state of a <see cref="T:System.Threading.Thread" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="MTA">
<MemberSignature Language="C#" Value="MTA" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.ApartmentState MTA = int32(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.ApartmentState</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.Thread" /> will create and enter a multithreaded apartment.</para>
</summary>
</Docs>
</Member>
<Member MemberName="STA">
<MemberSignature Language="C#" Value="STA" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.ApartmentState STA = int32(0)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.ApartmentState</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.Thread" /> will create and enter a single-threaded apartment.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
<MemberSignature Language="C#" Value="Unknown" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.ApartmentState Unknown = int32(2)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.ApartmentState</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Threading.Thread.ApartmentState" /> property has not been set.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

249
mcs/class/corlib/Documentation/en/System.Threading/AsyncFlowControl.xml Normal file
View File

@@ -0,0 +1,249 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AsyncFlowControl" FullName="System.Threading.AsyncFlowControl">
<TypeSignature Language="C#" Value="public struct AsyncFlowControl : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AsyncFlowControl extends System.ValueType implements class System.IDisposable" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An execution context contains all execution-related information for a logical thread. The flow of the execution context to other threads can be prevented by using the <see cref="M:System.Threading.ExecutionContext.SuppressFlow" /> method, which returns an <see cref="T:System.Threading.AsyncFlowControl" /> structure. The <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method of the returned <see cref="T:System.Threading.AsyncFlowControl" /> structure can be used to undo the flow suppression. The <see cref="T:System.Threading.AsyncFlowControl" /> structure must be used on the same thread on which it was created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the functionality to restore the migration, or flow, of the execution context between threads. </para>
</summary>
</Docs>
<Members>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call Dispose when you are finished using the <see cref="T:System.Threading.AsyncFlowControl" />. The Dispose method leaves the <see cref="T:System.Threading.AsyncFlowControl" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.Threading.AsyncFlowControl" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Threading.AsyncFlowControl" /> was occupying.</para>
<para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
<block subset="none" type="note">
<para>Always call Dispose before you release your last reference to the <see cref="T:System.Threading.AsyncFlowControl" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Threading.AsyncFlowControl" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the current instance of the <see cref="T:System.Threading.AsyncFlowControl" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the specified object is equal to the current <see cref="T:System.Threading.AsyncFlowControl" /> structure. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="obj" /> is an <see cref="T:System.Threading.AsyncFlowControl" /> structure and is equal to the current <see cref="T:System.Threading.AsyncFlowControl" /> structure; otherwise, false. </para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />An object to compare with the current structure.</param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Threading.AsyncFlowControl obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype System.Threading.AsyncFlowControl obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Threading.AsyncFlowControl" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the specified <see cref="T:System.Threading.AsyncFlowControl" /> structure is equal to the current <see cref="T:System.Threading.AsyncFlowControl" /> structure.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="obj" /> is equal to the current <see cref="T:System.Threading.AsyncFlowControl" /> structure; otherwise, false.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Threading.AsyncFlowControl" /> structure to compare with the current structure.</param>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a hash code for the current <see cref="T:System.Threading.AsyncFlowControl" /> structure.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A hash code for the current <see cref="T:System.Threading.AsyncFlowControl" /> structure.</para>
</returns>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Threading.AsyncFlowControl a, System.Threading.AsyncFlowControl b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Threading.AsyncFlowControl a, valuetype System.Threading.AsyncFlowControl b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.Threading.AsyncFlowControl" />
<Parameter Name="b" Type="System.Threading.AsyncFlowControl" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compares two <see cref="T:System.Threading.AsyncFlowControl" /> structures to determine whether they are equal. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the two structures are equal; otherwise, false. </para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Threading.AsyncFlowControl" /> structure.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Threading.AsyncFlowControl" /> structure.</param>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Threading.AsyncFlowControl a, System.Threading.AsyncFlowControl b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Threading.AsyncFlowControl a, valuetype System.Threading.AsyncFlowControl b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.Threading.AsyncFlowControl" />
<Parameter Name="b" Type="System.Threading.AsyncFlowControl" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compares two <see cref="T:System.Threading.AsyncFlowControl" /> structures to determine whether they are not equal. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the structures are not equal; otherwise, false. </para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Threading.AsyncFlowControl" /> structure.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Threading.AsyncFlowControl" /> structure.</param>
</Docs>
</Member>
<Member MemberName="System.IDisposable.Dispose">
<MemberSignature Language="C#" Value="void IDisposable.Dispose ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method calls the <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method to restore the associated <see cref="T:System.Threading.ExecutionContext" /> to its previous state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the <see cref="T:System.Threading.AsyncFlowControl" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Undo">
<MemberSignature Language="C#" Value="public void Undo ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Undo() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Threading.ExecutionContext.SuppressFlow" /> method returns an <see cref="T:System.Threading.AsyncFlowControl" /> structure that is used to restore the flow.</para>
<para>The <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method must be called only on the <see cref="T:System.Threading.AsyncFlowControl" /> structure returned by its associated <see cref="M:System.Threading.ExecutionContext.SuppressFlow" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the flow of the execution context between threads.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

130
mcs/class/corlib/Documentation/en/System.Threading/AutoResetEvent.xml Normal file
View File

@@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AutoResetEvent" FullName="System.Threading.AutoResetEvent">
<TypeSignature Maintainer="auto" Language="C#" Value="public sealed class AutoResetEvent : System.Threading.EventWaitHandle" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AutoResetEvent extends System.Threading.EventWaitHandle" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Threading.EventWaitHandle</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>AutoResetEvent allows threads to communicate with each other by signaling. Typically, you use this class when threads need exclusive access to a resource.</para>
<para>A thread waits for a signal by calling <see cref="M:System.Threading.WaitHandle.WaitOne(System.Int32,System.Boolean)" /> on the AutoResetEvent. If the AutoResetEvent is in the non-signaled state, the thread blocks, waiting for the thread that currently controls the resource to signal that the resource is available by calling <see cref="M:System.Threading.EventWaitHandle.Set" />.</para>
<para>Calling Set signals AutoResetEvent to release a waiting thread. AutoResetEvent remains signaled until a single waiting thread is released, and then automatically returns to the non-signaled state. If no threads are waiting, the state remains signaled indefinitely.</para>
<para>If a thread calls <see cref="M:System.Threading.WaitHandle.WaitOne(System.Int32,System.Boolean)" /> while the <see cref="T:System.Threading.AutoResetEvent" /> is in the signaled state, the thread does not block. The <see cref="T:System.Threading.AutoResetEvent" /> releases the thread immediately and returns to the non-signaled state.</para>
<block subset="none" type="note">
<para>There is no guarantee that every call to the <see cref="M:System.Threading.EventWaitHandle.Set" /> method will release a thread. If two calls are too close together, so that the second call occurs before a thread has been released, only one thread is released. It is as if the second call did not happen. Also, if <see cref="M:System.Threading.EventWaitHandle.Set" /> is called when there are no threads waiting and the <see cref="T:System.Threading.AutoResetEvent" /> is already signaled, the call has no effect. </para>
</block>
<para>You can control the initial state of an AutoResetEvent by passing a Boolean value to the constructor: true if the initial state is signaled and false otherwise.</para>
<para>AutoResetEvent can also be used with the static <see cref="M:System.Threading.WaitHandle.WaitAll(System.Threading.WaitHandle[],System.Int32,System.Boolean)" /> and <see cref="M:System.Threading.WaitHandle.WaitAny(System.Threading.WaitHandle[],System.Int32,System.Boolean)" /> methods.</para>
<para>For more information about thread synchronization mechanisms, see <format type="text/html"><a href="6d39c48d-6b37-4a9b-8631-f2924cfd9c18">AutoResetEvent</a></format> in the conceptual documentation.</para>
<para>Beginning with the .NET Framework version 2.0, <see cref="T:System.Threading.AutoResetEvent" /> derives from the new <see cref="T:System.Threading.EventWaitHandle" /> class. An <see cref="T:System.Threading.AutoResetEvent" /> is functionally equivalent to an <see cref="T:System.Threading.EventWaitHandle" /> created with <see cref="F:System.Threading.EventResetMode.AutoReset" />. </para>
<block subset="none" type="note">
<para>Unlike the <see cref="T:System.Threading.AutoResetEvent" /> class, the <see cref="T:System.Threading.EventWaitHandle" /> class provides access to named system synchronization events.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Notifies a waiting thread that an event has occurred. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutoResetEvent (bool initialState);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool initialState) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue />
<Parameters>
<Parameter Name="initialState" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.AutoResetEvent" /> class with a Boolean value indicating whether to set the initial state to signaled.</para>
</summary>
<param name="initialState">
<attribution license="cc4" from="Microsoft" modified="false" />true to set the initial state to signaled; false to set the initial state to non-signaled. </param>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public bool Reset ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<block subset="none" type="note">
<para>Starting with the dnprdnext and the compact_v35_long, this member is inherited from <see cref="T:System.Threading.EventWaitHandle" />.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the state of the event to nonsignaled, which causes threads to block.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the operation succeeds; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public bool Set ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<block subset="none" type="note">
<para>Starting with the dnprdnext and the compact_v35_long, this member is inherited from <see cref="T:System.Threading.EventWaitHandle" />. See <see cref="M:System.Threading.EventWaitHandle.Set" />.</para>
</block>
<para>The <see cref="M:System.Threading.AutoResetEvent.Set" /> method releases a single thread. If there are no waiting threads, the wait handle remains signaled until a thread attempts to wait on it, or until its <see cref="M:System.Threading.EventWaitHandle.Reset" /> method is called.</para>
<block subset="none" type="note">
<para>There is no guarantee that every call to the <see cref="M:System.Threading.AutoResetEvent.Set" /> method will release a thread. If two calls are too close together, so that the second call occurs before a thread has been released, only one thread is released — as if the second call did not happen. Also, if the <see cref="M:System.Threading.AutoResetEvent.Set" /> method is called when there are no threads waiting and the <see cref="T:System.Threading.AutoResetEvent" /> is already signaled, the call has no effect. </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the state of the event to signaled, which allows at most one waiting thread to proceed.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the operation succeeds; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

450
mcs/class/corlib/Documentation/en/System.Threading/CancellationToken.xml Normal file
View File

@@ -0,0 +1,450 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="CancellationToken" FullName="System.Threading.CancellationToken">
<TypeSignature Language="C#" Value="public struct CancellationToken" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit CancellationToken extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Diagnostics.DebuggerDisplay("IsCancellationRequested = {IsCancellationRequested}")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information and code examples see <format type="text/html"><a href="eea11fe5-d8b0-4314-bb5d-8a58166fb1c3">Cancellation</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Propagates notification that operations should be canceled.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CancellationToken (bool canceled);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool canceled) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="canceled" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Tokens created with this constructor will remain in the canceled state specified by the <paramref name="canceled" /> parameter. If <paramref name="canceled" /> is false, both <see cref="P:System.Threading.CancellationToken.CanBeCanceled" /> and <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> will be false.</para>
<para> If <paramref name="canceled" /> is true, both <see cref="P:System.Threading.CancellationToken.CanBeCanceled" /> and <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> will be true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the <see cref="T:System.Threading.CancellationToken" />.</para>
</summary>
<param name="canceled">
<attribution license="cc4" from="Microsoft" modified="false" />The canceled state for the token.</param>
</Docs>
</Member>
<Member MemberName="CanBeCanceled">
<MemberSignature Language="C#" Value="public bool CanBeCanceled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanBeCanceled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If CanBeCanceled returns false, it is guaranteed that the token will never transition into a canceled state, meaning that <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> will never return true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets whether this token is capable of being in the canceled state.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the current <see cref="T:System.Threading.CancellationToken" /> instance is equal to the specified <see cref="T:System.Object" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if <paramref name="other" /> is a <see cref="T:System.Threading.CancellationToken" /> and if the two instances are equal; otherwise, false. Two tokens are equal if they are associated with the same <see cref="T:System.Threading.CancellationTokenSource" /> or if they were both constructed from public CancellationToken constructors and their <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> values are equal.</para>
</returns>
<param name="other">
<attribution license="cc4" from="Microsoft" modified="false" />The other object to which to compare this instance.</param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Threading.CancellationToken other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype System.Threading.CancellationToken other) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the current <see cref="T:System.Threading.CancellationToken" /> instance is equal to the specified token.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if the instances are equal; otherwise, false. Two tokens are equal if they are associated with the same <see cref="T:System.Threading.CancellationTokenSource" /> or if they were both constructed from public CancellationToken constructors and their <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> values are equal.</para>
</returns>
<param name="other">
<attribution license="cc4" from="Microsoft" modified="false" />The other <see cref="T:System.Threading.CancellationToken" /> to which to compare this instance.</param>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Serves as a hash function for a <see cref="T:System.Threading.CancellationToken" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A hash code for the current <see cref="T:System.Threading.CancellationToken" /> instance.</para>
</returns>
</Docs>
</Member>
<Member MemberName="IsCancellationRequested">
<MemberSignature Language="C#" Value="public bool IsCancellationRequested { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCancellationRequested" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> This property indicates whether cancellation has been requested for this token, either through the token initially being constructed in a canceled state, or through calling <see cref="M:System.Threading.CancellationTokenSource.Cancel" /> on the token's associated <see cref="T:System.Threading.CancellationTokenSource" />.</para>
<para> If this property is true, it only guarantees that cancellation has been requested. </para>
<para> It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets whether cancellation has been requested for this token.</para>
</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="public static System.Threading.CancellationToken None { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype System.Threading.CancellationToken None" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.CancellationToken" /> value returned by this property will be non-cancelable by default.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns an empty CancellationToken value.</para>
</summary>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Threading.CancellationToken left, System.Threading.CancellationToken right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Threading.CancellationToken left, valuetype System.Threading.CancellationToken right) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="System.Threading.CancellationToken" />
<Parameter Name="right" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether two <see cref="T:System.Threading.CancellationToken" /> instances are equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if the instances are equal; otherwise, false.</para>
</returns>
<param name="left">
<attribution license="cc4" from="Microsoft" modified="false" />The first instance.</param>
<param name="right">
<attribution license="cc4" from="Microsoft" modified="false" />The second instance.</param>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Threading.CancellationToken left, System.Threading.CancellationToken right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Threading.CancellationToken left, valuetype System.Threading.CancellationToken right) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="System.Threading.CancellationToken" />
<Parameter Name="right" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether two <see cref="T:System.Threading.CancellationToken" /> instances are not equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if the instances are not equal; otherwise, false.</para>
</returns>
<param name="left">
<attribution license="cc4" from="Microsoft" modified="false" />The first instance.</param>
<param name="right">
<attribution license="cc4" from="Microsoft" modified="false" />The second instance.</param>
</Docs>
</Member>
<Member MemberName="Register">
<MemberSignature Language="C#" Value="public System.Threading.CancellationTokenRegistration Register (Action callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Threading.CancellationTokenRegistration Register(class System.Action callback) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenRegistration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Action" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates will be propagated out of this method call.</para>
<para> The current <see cref="T:System.Threading.ExecutionContext" />, if one exists, will be captured along with the delegate and will be used when executing it.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers a delegate that will be called when this <see cref="T:System.Threading.CancellationToken" /> is canceled.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.CancellationTokenRegistration" /> instance that can be used to deregister the callback.</para>
</returns>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The delegate to be executed when the <see cref="T:System.Threading.CancellationToken" /> is canceled.</param>
</Docs>
</Member>
<Member MemberName="Register">
<MemberSignature Language="C#" Value="public System.Threading.CancellationTokenRegistration Register (Action callback, bool useSynchronizationContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Threading.CancellationTokenRegistration Register(class System.Action callback, bool useSynchronizationContext) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenRegistration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Action" />
<Parameter Name="useSynchronizationContext" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates will be propogated out of this method call.</para>
<para> The current <see cref="T:System.Threading.ExecutionContext" />, if one exists, will be captured along with the delegate and will be used when executing it.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers a delegate that will be called when this <see cref="T:System.Threading.CancellationToken" /> is canceled.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.CancellationTokenRegistration" /> instance that can be used to deregister the callback.</para>
</returns>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The delegate to be executed when the <see cref="T:System.Threading.CancellationToken" /> is canceled.</param>
<param name="useSynchronizationContext">
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value that indicates whether to capture the current <see cref="T:System.Threading.SynchronizationContext" /> and use it when invoking the <paramref name="callback" />.</param>
</Docs>
</Member>
<Member MemberName="Register">
<MemberSignature Language="C#" Value="public System.Threading.CancellationTokenRegistration Register (Action&lt;object&gt; callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Threading.CancellationTokenRegistration Register(class System.Action`1&lt;object&gt; callback, object state) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenRegistration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Action&lt;System.Object&gt;" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates will be propogated out of this method call.</para>
<para> The current <see cref="T:System.Threading.ExecutionContext" />, if one exists, will be captured along with the delegate and will be used when executing it.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers a delegate that will be called when this <see cref="T:System.Threading.CancellationToken" /> is canceled.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.CancellationTokenRegistration" /> instance that can be used to deregister the callback.</para>
</returns>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The delegate to be executed when the <see cref="T:System.Threading.CancellationToken" /> is canceled.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />The state to pass to the <paramref name="callback" /> when the delegate is invoked. This may be null.</param>
</Docs>
</Member>
<Member MemberName="Register">
<MemberSignature Language="C#" Value="public System.Threading.CancellationTokenRegistration Register (Action&lt;object&gt; callback, object state, bool useSynchronizationContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Threading.CancellationTokenRegistration Register(class System.Action`1&lt;object&gt; callback, object state, bool useSynchronizationContext) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenRegistration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.Action&lt;System.Object&gt;" />
<Parameter Name="state" Type="System.Object" />
<Parameter Name="useSynchronizationContext" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates will be propogated out of this method call.</para>
<para> The current <see cref="T:System.Threading.ExecutionContext" />, if one exists, will be captured along with the delegate and will be used when executing it.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers a delegate that will be called when this <see cref="T:System.Threading.CancellationToken" /> is canceled.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.CancellationTokenRegistration" /> instance that can be used to deregister the callback.</para>
</returns>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The delegate to be executed when the <see cref="T:System.Threading.CancellationToken" /> is canceled.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />The state to pass to the <paramref name="callback" /> when the delegate is invoked. This may be null.</param>
<param name="useSynchronizationContext">
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value that indicates whether to capture the current <see cref="T:System.Threading.SynchronizationContext" /> and use it when invoking the <paramref name="callback" />.</param>
</Docs>
</Member>
<Member MemberName="ThrowIfCancellationRequested">
<MemberSignature Language="C#" Value="public void ThrowIfCancellationRequested ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ThrowIfCancellationRequested() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method provides functionality equivalent to:</para>
<para>C#</para>
<code> if (token.IsCancellationRequested)
throw new OperationCanceledException(token);</code>
<code> If token.IsCancellationRequested Then
Throw New OperationCanceledException(token)
End If</code>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Throws a <see cref="T:System.OperationCanceledException" /> if this token has had cancellation requested.</para>
</summary>
</Docs>
</Member>
<Member MemberName="WaitHandle">
<MemberSignature Language="C#" Value="public System.Threading.WaitHandle WaitHandle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Threading.WaitHandle WaitHandle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.WaitHandle</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Accessing this property causes a <see cref="T:System.Threading.WaitHandle" /> to be instantiated. It is preferable to only use this property when necessary, and to then dispose the associated <see cref="T:System.Threading.CancellationTokenSource" /> instance at the earliest opportunity (disposing the source will dispose of this allocated handle). The handle should not be closed or disposed directly.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Threading.WaitHandle" /> that is signaled when the token is canceled.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

197
mcs/class/corlib/Documentation/en/System.Threading/CancellationTokenRegistration.xml Normal file
View File

@@ -0,0 +1,197 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="CancellationTokenRegistration" FullName="System.Threading.CancellationTokenRegistration">
<TypeSignature Language="C#" Value="public struct CancellationTokenRegistration : IDisposable, IEquatable&lt;System.Threading.CancellationTokenRegistration&gt;" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit CancellationTokenRegistration extends System.ValueType implements class System.IDisposable, class System.IEquatable`1&lt;valuetype System.Threading.CancellationTokenRegistration&gt;" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IEquatable&lt;System.Threading.CancellationTokenRegistration&gt;</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The callback is called when the token is canceled. To unregister a callback, dispose the corresponding Registration instance. For more information and code examples see <format type="text/html"><a href="eea11fe5-d8b0-4314-bb5d-8a58166fb1c3">Cancellation</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a callback delegate that has been registered with a <see cref="T:System.Threading.CancellationToken" />. </para>
</summary>
</Docs>
<Members>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call Dispose when you are finished using the <see cref="T:System.Threading.CancellationTokenRegistration" />. The Dispose method leaves the <see cref="T:System.Threading.CancellationTokenRegistration" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.Threading.CancellationTokenRegistration" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Threading.CancellationTokenRegistration" /> was occupying.</para>
<para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
<block subset="none" type="note">
<para>Always call Dispose before you release your last reference to the <see cref="T:System.Threading.CancellationTokenRegistration" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Threading.CancellationTokenRegistration" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the current instance of the <see cref="T:System.Threading.CancellationTokenRegistration" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the current <see cref="T:System.Threading.CancellationTokenRegistration" /> instance is equal to the specified <see cref="T:System.Threading.CancellationTokenRegistration" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True, if both this and <paramref name="obj" /> are equal. False, otherwise.</para>
<para>Two <see cref="T:System.Threading.CancellationTokenRegistration" /> instances are equal if they both refer to the output of a single call to the same Register method of a <see cref="T:System.Threading.CancellationToken" />.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />The other object to which to compare this instance.</param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Threading.CancellationTokenRegistration other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype System.Threading.CancellationTokenRegistration other) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Threading.CancellationTokenRegistration" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the current <see cref="T:System.Threading.CancellationTokenRegistration" /> instance is equal to the specified <see cref="T:System.Threading.CancellationTokenRegistration" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True, if both this and <paramref name="other" /> are equal. False, otherwise.</para>
<para> Two <see cref="T:System.Threading.CancellationTokenRegistration" /> instances are equal if they both refer to the output of a single call to the same Register method of a <see cref="T:System.Threading.CancellationToken" />.</para>
</returns>
<param name="other">
<attribution license="cc4" from="Microsoft" modified="false" />The other <see cref="T:System.Threading.CancellationTokenRegistration" /> to which to compare this instance.</param>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Serves as a hash function for a <see cref="T:System.Threading.CancellationTokenRegistration" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A hash code for the current <see cref="T:System.Threading.CancellationTokenRegistration" /> instance.</para>
</returns>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Threading.CancellationTokenRegistration left, System.Threading.CancellationTokenRegistration right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Threading.CancellationTokenRegistration left, valuetype System.Threading.CancellationTokenRegistration right) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="System.Threading.CancellationTokenRegistration" />
<Parameter Name="right" Type="System.Threading.CancellationTokenRegistration" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether two <see cref="T:System.Threading.CancellationTokenRegistration" /> instances are equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if the instances are equal; otherwise, false.</para>
</returns>
<param name="left">
<attribution license="cc4" from="Microsoft" modified="false" />The first instance.</param>
<param name="right">
<attribution license="cc4" from="Microsoft" modified="false" />The second instance.</param>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Threading.CancellationTokenRegistration left, System.Threading.CancellationTokenRegistration right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Threading.CancellationTokenRegistration left, valuetype System.Threading.CancellationTokenRegistration right) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="System.Threading.CancellationTokenRegistration" />
<Parameter Name="right" Type="System.Threading.CancellationTokenRegistration" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether two <see cref="T:System.Threading.CancellationTokenRegistration" /> instances are not equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>True if the instances are not equal; otherwise, false.</para>
</returns>
<param name="left">
<attribution license="cc4" from="Microsoft" modified="false" />The first instance.</param>
<param name="right">
<attribution license="cc4" from="Microsoft" modified="false" />The second instance.</param>
</Docs>
</Member>
</Members>
</Type>

357
mcs/class/corlib/Documentation/en/System.Threading/CancellationTokenSource.xml Normal file
View File

@@ -0,0 +1,357 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="CancellationTokenSource" FullName="System.Threading.CancellationTokenSource">
<TypeSignature Language="C#" Value="public class CancellationTokenSource : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi CancellationTokenSource extends System.Object implements class System.IDisposable" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information, see <format type="text/html"><a href="eea11fe5-d8b0-4314-bb5d-8a58166fb1c3">Cancellation</a></format>. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Signals to a <see cref="T:System.Threading.CancellationToken" /> that it should be canceled.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CancellationTokenSource ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CancellationTokenSource (int millisecondsDelay);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 millisecondsDelay) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="millisecondsDelay" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The countdown for the <paramref name="millisecondsDelay" /> starts during the call to the constructor. When the <paramref name="millisecondsDelay" /> expires, the constructed <see cref="T:System.Threading.CancellationTokenSource" /> is canceled (if it has not been canceled already).</para>
<para>Subsequent calls to <see cref="M:System.Threading.CancellationTokenSource.CancelAfter(System.Int32)" /> will reset the <paramref name="millisecondsDelay" /> for the constructed <see cref="T:System.Threading.CancellationTokenSource" />, if it has not been canceled already.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class that will be canceled after the specified delay in milliseconds.</para>
</summary>
<param name="millisecondsDelay">
<attribution license="cc4" from="Microsoft" modified="false" />The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CancellationTokenSource (TimeSpan delay);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan delay) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="delay" Type="System.TimeSpan" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The countdown for the delay starts during the call to the constructor. When the delay expires, the constructed <see cref="T:System.Threading.CancellationTokenSource" /> is canceled, if it has not been canceled already.</para>
<para>Subsequent calls to <see cref="M:System.Threading.CancellationTokenSource.CancelAfter(System.TimeSpan)" /> will reset the delay for the constructed <see cref="T:System.Threading.CancellationTokenSource" />, if it has not been canceled already.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class that will be canceled after the specified time span.</para>
</summary>
<param name="delay">
<attribution license="cc4" from="Microsoft" modified="false" />The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Cancel() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> The associated <see cref="T:System.Threading.CancellationToken" /> will be notified of the cancellation and will transition to a state where <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> returns true. </para>
<para>Any callbacks or cancelable operations registered with the <see cref="T:System.Threading.CancellationToken" /> will be executed.</para>
<para>Cancelable operations and callbacks registered with the token should not throw exceptions.</para>
<para>However, this overload of Cancel will aggregate any exceptions thrown into an <see cref="T:System.AggregateException" />, such that one callback throwing an exception will not prevent other registered callbacks from being executed.</para>
<para>The <see cref="T:System.Threading.ExecutionContext" /> that was captured when each callback was registered will be reestablished when the callback is invoked.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Communicates a request for cancellation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel (bool throwOnFirstException);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Cancel(bool throwOnFirstException) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="throwOnFirstException" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> The associated <see cref="T:System.Threading.CancellationToken" /> will be notified of the cancellation and will transition to a state where <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> returns true. </para>
<para>Any callbacks or cancelable operations registered with the <see cref="T:System.Threading.CancellationToken" /> will be executed.</para>
<para>Cancelable operations and callbacks registered with the token should not throw exceptions. </para>
<para>If <paramref name="throwOnFirstException" /> is true, an exception will immediately propagate out of the call to <see cref="M:System.Threading.CancellationTokenSource.Cancel(System.Boolean)" />, preventing the remaining callbacks and cancelable operations from being processed.</para>
<para> If <paramref name="throwOnFirstException" /> is false, this overload will aggregate any exceptions thrown into an <see cref="T:System.AggregateException" />, such that one callback throwing an exception will not prevent other registered callbacks from being executed.</para>
<para>The <see cref="T:System.Threading.ExecutionContext" /> that was captured when each callback was registered will be reestablished when the callback is invoked.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed.</para>
</summary>
<param name="throwOnFirstException">
<attribution license="cc4" from="Microsoft" modified="false" />true if exceptions should immediately propagate; otherwise, false.</param>
</Docs>
</Member>
<Member MemberName="CancelAfter">
<MemberSignature Language="C#" Value="public void CancelAfter (int millisecondsDelay);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CancelAfter(int32 millisecondsDelay) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="millisecondsDelay" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The countdown for the <paramref name="millisecondsDelay" /> starts during this call. When the <paramref name="millisecondsDelay" /> expires, this <see cref="T:System.Threading.CancellationTokenSource" /> is canceled, if it has not been canceled already.</para>
<para>Subsequent calls to CancelAfter will reset the <paramref name="millisecondsDelay" /> for this <see cref="T:System.Threading.CancellationTokenSource" />, if it has not been canceled already.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Schedules a cancel operation on this <see cref="T:System.Threading.CancellationTokenSource" /> after the specified number of milliseconds.</para>
</summary>
<param name="millisecondsDelay">
<attribution license="cc4" from="Microsoft" modified="false" />The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
</Docs>
</Member>
<Member MemberName="CancelAfter">
<MemberSignature Language="C#" Value="public void CancelAfter (TimeSpan delay);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CancelAfter(valuetype System.TimeSpan delay) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="delay" Type="System.TimeSpan" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Schedules a cancel operation on this <see cref="T:System.Threading.CancellationTokenSource" /> after the specified time span.</para>
</summary>
<param name="delay">
<attribution license="cc4" from="Microsoft" modified="false" />The time span to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource" />.</param>
</Docs>
</Member>
<Member MemberName="CreateLinkedTokenSource">
<MemberSignature Language="C#" Value="public static System.Threading.CancellationTokenSource CreateLinkedTokenSource (System.Threading.CancellationToken[] tokens);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.CancellationTokenSource CreateLinkedTokenSource(valuetype System.Threading.CancellationToken[] tokens) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenSource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tokens" Type="System.Threading.CancellationToken[]">
<Attributes>
<Attribute>
<AttributeName>System.ParamArray</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a <see cref="T:System.Threading.CancellationTokenSource" /> that will be in the canceled state when any of the source tokens in the specified array are in the canceled state.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.CancellationTokenSource" /> that is linked to the source tokens.</para>
</returns>
<param name="tokens">
<attribution license="cc4" from="Microsoft" modified="false" />An array that contains the cancellation token instances to observe.</param>
</Docs>
</Member>
<Member MemberName="CreateLinkedTokenSource">
<MemberSignature Language="C#" Value="public static System.Threading.CancellationTokenSource CreateLinkedTokenSource (System.Threading.CancellationToken token1, System.Threading.CancellationToken token2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.CancellationTokenSource CreateLinkedTokenSource(valuetype System.Threading.CancellationToken token1, valuetype System.Threading.CancellationToken token2) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationTokenSource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token1" Type="System.Threading.CancellationToken" />
<Parameter Name="token2" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a <see cref="T:System.Threading.CancellationTokenSource" /> that will be in the canceled state when any of the source tokens are in the canceled state.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.CancellationTokenSource" /> that is linked to the source tokens.</para>
</returns>
<param name="token1">
<attribution license="cc4" from="Microsoft" modified="false" />The first cancellation token to observe.</param>
<param name="token2">
<attribution license="cc4" from="Microsoft" modified="false" />The second cancellation token to observe.</param>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call Dispose when you are finished using the <see cref="T:System.Threading.CancellationTokenSource" />. The Dispose method leaves the <see cref="T:System.Threading.CancellationTokenSource" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.Threading.CancellationTokenSource" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Threading.CancellationTokenSource" /> was occupying.</para>
<para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
<block subset="none" type="note">
<para>Always call Dispose before you release your last reference to the <see cref="T:System.Threading.CancellationTokenSource" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Threading.CancellationTokenSource" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the current instance of the <see cref="T:System.Threading.CancellationTokenSource" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases the unmanaged resources used by the <see cref="T:System.Threading.CancellationTokenSource" /> class and optionally releases the managed resources.</para>
</summary>
<param name="disposing">
<attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
</Docs>
</Member>
<Member MemberName="IsCancellationRequested">
<MemberSignature Language="C#" Value="public bool IsCancellationRequested { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCancellationRequested" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> This property indicates whether cancellation has been requested for this token source, such as due to a call to its <see cref="M:System.Threading.CancellationTokenSource.Cancel" /> method.</para>
<para> If this property returns true, it only guarantees that cancellation has been requested. It does not guarantee that every handler registered with the corresponding token has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.</para>
<para> </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets whether cancellation has been requested for this <see cref="T:System.Threading.CancellationTokenSource" />.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Token">
<MemberSignature Language="C#" Value="public System.Threading.CancellationToken Token { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.CancellationToken Token" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:System.Threading.CancellationToken" /> associated with this <see cref="T:System.Threading.CancellationTokenSource" />.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

212
mcs/class/corlib/Documentation/en/System.Threading/CompressedStack.xml Normal file
View File

@@ -0,0 +1,212 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="CompressedStack" FullName="System.Threading.CompressedStack">
<TypeSignature Language="C#" Value="public sealed class CompressedStack : System.Runtime.Serialization.ISerializable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed beforefieldinit CompressedStack extends System.Object implements class System.Runtime.Serialization.ISerializable" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The compressed stack is a compact representation of all the code access security information on the call stack, such as <see cref="M:System.Security.CodeAccessPermission.Deny" /> and <see cref="M:System.Security.CodeAccessPermission.Assert" /> actions. For example, if a <see cref="M:System.Security.CodeAccessPermission.Deny" /> action is two stack frames up from the current frame and there are no other code access security annotations between there and the current frame, the compressed stack records only that information, without having to serialize the entire call stack. </para>
<para>The <see cref="T:System.Threading.CompressedStack" /> class is used internally by the <see cref="T:System.Security.SecurityContext" /> class. For example, the <see cref="M:System.Security.SecurityContext.Capture" /> method captures the compressed stack for the current call stack, along with impersonation and culture information. The <see cref="T:System.Security.SecurityContext" /> class is used in turn by the <see cref="T:System.Threading.ExecutionContext" /> class to flow context across threads, for example when scheduling thread pool tasks.</para>
<para>This class is not used in ordinary application programming.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides methods for setting and capturing the compressed stack on the current thread. This class cannot be inherited. </para>
</summary>
</Docs>
<Members>
<Member MemberName="Capture">
<MemberSignature Language="C#" Value="public static System.Threading.CompressedStack Capture ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.CompressedStack Capture() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CompressedStack</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Captures all the code access security information on the call stack, such as <see cref="M:System.Security.CodeAccessPermission.Deny" /> and <see cref="M:System.Security.CodeAccessPermission.Assert" /> actions, in a compressed format. For example, if a <see cref="M:System.Security.CodeAccessPermission.Deny" /> action is two stack frames up from the current frame and there are no other code access security annotations between there and the current frame, the compressed stack records only that information, without having to serialize the entire call stack. </para>
<para>The captured compressed stack can be applied to another thread. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Captures the compressed stack from the current thread.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.CompressedStack" /> object.</para>
</returns>
</Docs>
</Member>
<Member MemberName="CreateCopy">
<MemberSignature Language="C#" Value="public System.Threading.CompressedStack CreateCopy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.CompressedStack CreateCopy() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.CompressedStack</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is useful for creating a copy of the current compressed stack to apply to another thread.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a copy of the current compressed stack.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.CompressedStack" /> object representing the current compressed stack.</para>
</returns>
</Docs>
</Member>
<Member MemberName="GetCompressedStack">
<MemberSignature Language="C#" Value="public static System.Threading.CompressedStack GetCompressedStack ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.CompressedStack GetCompressedStack() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.CompressedStack</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If security is enabled, the current compressed stack is returned. If security is disabled, <see cref="M:System.Threading.CompressedStack.GetCompressedStack" /> returns an empty <see cref="T:System.Threading.CompressedStack" /> object.</para>
<block subset="none" type="note">
<para>This method uses <see cref="F:System.Security.Permissions.SecurityAction.LinkDemand" /> to prevent it from being called from untrusted code; only the immediate caller is required to have <see cref="P:System.Security.Permissions.SecurityPermissionAttribute.UnmanagedCode" /> permission. For important limitations on using the LinkDemand member, see <format type="text/html"><a href="1ab877f2-70f4-4e0d-8116-943999dfe8f5">Demand vs. LinkDemand</a></format>.</para>
</block>
<block subset="none" type="note">
<para>This member also makes a link demand for the ECMA public key, which is not a valid cryptographic key but a pseudo key. Within the .NET Framework the link demand for the ECMA pseudo key is automatically converted to a link demand for the Microsoft public key. The security exception is based on the Microsoft public key, not the ECMA pseudo key.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the compressed stack for the current thread.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.CompressedStack" /> for the current thread.</para>
</returns>
</Docs>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</Member>
<Member MemberName="GetObjectData">
<MemberSignature Language="C#" Value="public void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Threading.CompressedStack.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" /> sets a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the logical call context information. During deserialization, the execution context object is reconstituted from the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> transmitted over the stream.</para>
<para>For more information, see <see cref="T:System.Runtime.Serialization.SerializationInfo" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object with the logical context information needed to recreate an instance of this execution context.</para>
</summary>
<param name="info">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object to be populated with serialization information. </param>
<param name="context">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure representing the destination context of the serialization. </param>
</Docs>
</Member>
<Member MemberName="Run">
<MemberSignature Language="C#" Value="public static void Run (System.Threading.CompressedStack compressedStack, System.Threading.ContextCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Run(class System.Threading.CompressedStack compressedStack, class System.Threading.ContextCallback callback, object state) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="compressedStack" Type="System.Threading.CompressedStack" />
<Parameter Name="callback" Type="System.Threading.ContextCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The compressed stack is returned to its previous state when the method completes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Runs a method in the specified compressed stack on the current thread.</para>
</summary>
<param name="compressedStack">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.CompressedStack" /> to set.</param>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Threading.ContextCallback" /> that represents the method to be run in the specified security context.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />The object to be passed to the callback method.</param>
</Docs>
</Member>
</Members>
</Type>

38
mcs/class/corlib/Documentation/en/System.Threading/ContextCallback.xml Normal file
View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ContextCallback" FullName="System.Threading.ContextCallback">
<TypeSignature Language="C#" Value="public delegate void ContextCallback(object state);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed ContextCallback extends System.MulticastDelegate" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="state" Type="System.Object" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="state">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Threading.ContextCallback" /> is used by the <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> and the <see cref="M:System.Security.SecurityContext.Run(System.Security.SecurityContext,System.Threading.ContextCallback,System.Object)" /> methods. <see cref="T:System.Threading.ContextCallback" /> represents the method to be run in the provided context. Upon completion of the method execution, the context is restored to its previous state. </para>
<para>Create the delegate by passing your callback method to the <see cref="T:System.Threading.ContextCallback" /> constructor. Your method must have the signature shown here.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a method to be called within a new context. </para>
</summary>
</Docs>
</Type>

538
mcs/class/corlib/Documentation/en/System.Threading/CountdownEvent.xml Normal file
View File

File diff suppressed because it is too large Load Diff

66
mcs/class/corlib/Documentation/en/System.Threading/EventResetMode.xml Normal file
View File

@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EventResetMode" FullName="System.Threading.EventResetMode">
<TypeSignature Language="C#" Value="public enum EventResetMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed EventResetMode extends System.Enum" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether an <see cref="T:System.Threading.EventWaitHandle" /> is reset automatically or manually after receiving a signal.</para>
</summary>
</Docs>
<Members>
<Member MemberName="AutoReset">
<MemberSignature Language="C#" Value="AutoReset" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.EventResetMode AutoReset = int32(0)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.EventResetMode</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When signaled, the <see cref="T:System.Threading.EventWaitHandle" /> resets automatically after releasing a single thread. If no threads are waiting, the <see cref="T:System.Threading.EventWaitHandle" /> remains signaled until a thread blocks, and resets after releasing the thread.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ManualReset">
<MemberSignature Language="C#" Value="ManualReset" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.EventResetMode ManualReset = int32(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.EventResetMode</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When signaled, the <see cref="T:System.Threading.EventWaitHandle" /> releases all waiting threads and remains signaled until it is manually reset.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

387
mcs/class/corlib/Documentation/en/System.Threading/EventWaitHandle.xml Normal file
View File

@@ -0,0 +1,387 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EventWaitHandle" FullName="System.Threading.EventWaitHandle">
<TypeSignature Language="C#" Value="public class EventWaitHandle : System.Threading.WaitHandle" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventWaitHandle extends System.Threading.WaitHandle" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Threading.WaitHandle</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.EventWaitHandle" /> class allows threads to communicate with each other by signaling. Typically, one or more threads block on an <see cref="T:System.Threading.EventWaitHandle" /> until an unblocked thread calls the <see cref="M:System.Threading.EventWaitHandle.Set" /> method, releasing one or more of the blocked threads. A thread can signal an <see cref="T:System.Threading.EventWaitHandle" /> and then block on it, by calling the static (Shared in Visual Basic) <see cref="Overload:System.Threading.WaitHandle.SignalAndWait" /> method.</para>
<block subset="none" type="note">
<para>The <see cref="T:System.Threading.EventWaitHandle" /> class provides access to named system synchronization events.</para>
</block>
<para>The behavior of an <see cref="T:System.Threading.EventWaitHandle" /> that has been signaled depends on its reset mode. An <see cref="T:System.Threading.EventWaitHandle" /> created with the <see cref="F:System.Threading.EventResetMode.AutoReset" /> flag resets automatically when signaled, after releasing a single waiting thread. An <see cref="T:System.Threading.EventWaitHandle" /> created with the <see cref="F:System.Threading.EventResetMode.ManualReset" /> flag remains signaled until its <see cref="M:System.Threading.EventWaitHandle.Reset" /> method is called.</para>
<para>Automatic reset events provide exclusive access to a resource. If an automatic reset event is signaled when no threads are waiting, it remains signaled until a thread attempts to wait on it. The event releases the thread and immediately resets, blocking subsequent threads.</para>
<para>Manual reset events are like gates. When the event is not signaled, threads that wait on it will block. When the event is signaled, all waiting threads are released, and the event remains signaled (that is, subsequent waits do not block) until its <see cref="M:System.Threading.EventWaitHandle.Reset" /> method is called. Manual reset events are useful when one thread must complete an activity before other threads can proceed.</para>
<para>
<see cref="T:System.Threading.EventWaitHandle" /> objects can be used with the static (Shared in Visual Basic) <see cref="Overload:System.Threading.WaitHandle.WaitAll" /> and <see cref="Overload:System.Threading.WaitHandle.WaitAny" /> methods.</para>
<para>For more information about thread synchronization mechanisms, see <format type="text/html"><a href="cd94fc34-ac15-427f-b723-a1240a4fab7d">EventWaitHandle, AutoResetEvent, and ManualResetEvent</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a thread synchronization event.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool initialState, valuetype System.Threading.EventResetMode mode) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="initialState" Type="System.Boolean" />
<Parameter Name="mode" Type="System.Threading.EventResetMode" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the initial state of the event is nonsignaled, threads that wait on the event will block. If the initial state is signaled, and the <see cref="F:System.Threading.EventResetMode.ManualReset" /> flag is specified for <paramref name="mode" />, threads that wait on the event will not block. If the initial state is signaled, and <paramref name="mode" /> is <see cref="F:System.Threading.EventResetMode.AutoReset" />, the first thread that waits on the event will be released immediately, after which the event will reset, and subsequent threads will block.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.EventWaitHandle" /> class, specifying whether the wait handle is initially signaled, and whether it resets automatically or manually.</para>
</summary>
<param name="initialState">
<attribution license="cc4" from="Microsoft" modified="false" />true to set the initial state to signaled; false to set it to nonsignaled.</param>
<param name="mode">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Threading.EventResetMode" /> values that determines whether the event resets automatically or manually.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode, string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool initialState, valuetype System.Threading.EventResetMode mode, string name) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="initialState" Type="System.Boolean" />
<Parameter Name="mode" Type="System.Threading.EventResetMode" />
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If <paramref name="name" /> is null or an empty string, a local <see cref="T:System.Threading.EventWaitHandle" /> is created.</para>
<para>If a system event with the name specified for the <paramref name="name" /> parameter already exists, the <paramref name="initialState" /> parameter is ignored.</para>
<block subset="none" type="note">
<para>When using this constructor for named system events, specify false for <paramref name="initialState" />. This constructor provides no way to determine whether a named system event was created, so you cannot make any assumptions about the state of the named event. To determine whether a named event was created, use the <see cref="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String,System.Boolean@)" /> constructor or the <see cref="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String,System.Boolean@,System.Security.AccessControl.EventWaitHandleSecurity)" /> constructor.</para>
</block>
<para>If the initial state of the event is nonsignaled, threads that wait on the event will block. If the initial state is signaled, and the <see cref="F:System.Threading.EventResetMode.ManualReset" /> flag is specified for <paramref name="mode" />, threads that wait on the event will not block. If the initial state is signaled, and <paramref name="mode" /> is <see cref="F:System.Threading.EventResetMode.AutoReset" />, the first thread that waits on the event will be released immediately, after which the event will reset, and subsequent threads will block.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.EventWaitHandle" /> class, specifying whether the wait handle is initially signaled if created as a result of this call, whether it resets automatically or manually, and the name of a system synchronization event.</para>
</summary>
<param name="initialState">
<attribution license="cc4" from="Microsoft" modified="false" />true to set the initial state to signaled if the named event is created as a result of this call; false to set it to nonsignaled.</param>
<param name="mode">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Threading.EventResetMode" /> values that determines whether the event resets automatically or manually.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of a system-wide synchronization event.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode, string name, out bool createdNew);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool initialState, valuetype System.Threading.EventResetMode mode, string name, bool createdNew) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="initialState" Type="System.Boolean" />
<Parameter Name="mode" Type="System.Threading.EventResetMode" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="createdNew" Type="System.Boolean&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="initialState">To be added.</param>
<param name="mode">To be added.</param>
<param name="name">To be added.</param>
<param name="createdNew">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode, string name, out bool createdNew, System.Security.AccessControl.EventWaitHandleSecurity eventSecurity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool initialState, valuetype System.Threading.EventResetMode mode, string name, bool createdNew, class System.Security.AccessControl.EventWaitHandleSecurity eventSecurity) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="initialState" Type="System.Boolean" />
<Parameter Name="mode" Type="System.Threading.EventResetMode" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="createdNew" Type="System.Boolean&amp;" RefType="out" />
<Parameter Name="eventSecurity" Type="System.Security.AccessControl.EventWaitHandleSecurity" />
</Parameters>
<Docs>
<param name="initialState">To be added.</param>
<param name="mode">To be added.</param>
<param name="name">To be added.</param>
<param name="createdNew">To be added.</param>
<param name="eventSecurity">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
</Member>
<Member MemberName="GetAccessControl">
<MemberSignature Language="C#" Value="public System.Security.AccessControl.EventWaitHandleSecurity GetAccessControl ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Security.AccessControl.EventWaitHandleSecurity GetAccessControl() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.AccessControl.EventWaitHandleSecurity</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Threading.EventWaitHandle.GetAccessControl" /> method uses the following combination of flags (combined using the bitwise OR operation) to search for permissions: <see cref="F:System.Security.AccessControl.AccessControlSections.Access" />, <see cref="F:System.Security.AccessControl.AccessControlSections.Owner" />, and <see cref="F:System.Security.AccessControl.AccessControlSections.Group" />.</para>
<para>The user must have <see cref="F:System.Security.AccessControl.EventWaitHandleRights.ReadPermissions" /> rights to call this method, and the event must have been opened with the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.ReadPermissions" /> flag.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets an <see cref="T:System.Security.AccessControl.EventWaitHandleSecurity" /> object that represents the access control security for the named system event represented by the current <see cref="T:System.Threading.EventWaitHandle" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Security.AccessControl.EventWaitHandleSecurity" /> object that represents the access control security for the named system event.</para>
</returns>
</Docs>
</Member>
<Member MemberName="OpenExisting">
<MemberSignature Language="C#" Value="public static System.Threading.EventWaitHandle OpenExisting (string name);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.EventWaitHandle OpenExisting(string name) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.EventWaitHandle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="Overload:System.Threading.EventWaitHandle.OpenExisting" /> method tries to open the specified named system event. If the system event does not exist, this method throws an exception instead of creating the system event. To create the system event when it does not already exist, use one of the <see cref="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String,System.Boolean@,System.Security.AccessControl.EventWaitHandleSecurity)" /> constructors that has a <paramref name="name" /> parameter. </para>
<para>Multiple calls to this method that use the same value for <paramref name="name" /> do not necessarily return the same <see cref="T:System.Threading.EventWaitHandle" /> object, even though the objects that are returned represent the same named system event. </para>
<para>This method overload is equivalent to calling the <see cref="M:System.Threading.EventWaitHandle.OpenExisting(System.String,System.Security.AccessControl.EventWaitHandleRights)" /> method overload and specifying <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Synchronize" /> and <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Modify" /> rights, combined by using the bitwise OR operation.</para>
<para>Specifying the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Synchronize" /> flag allows a thread to wait on the named system event, and specifying the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Modify" /> flag allows a thread to call the <see cref="M:System.Threading.EventWaitHandle.Set" /> and <see cref="M:System.Threading.EventWaitHandle.Reset" /> methods.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Opens the specified named synchronization event, if it already exists.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An object that represents the named system event.</para>
</returns>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the system synchronization event to open.</param>
</Docs>
</Member>
<Member MemberName="OpenExisting">
<MemberSignature Language="C#" Value="public static System.Threading.EventWaitHandle OpenExisting (string name, System.Security.AccessControl.EventWaitHandleRights rights);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.EventWaitHandle OpenExisting(string name, valuetype System.Security.AccessControl.EventWaitHandleRights rights) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.EventWaitHandle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="rights" Type="System.Security.AccessControl.EventWaitHandleRights" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="rights" /> parameter must include the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Synchronize" /> flag to allow threads to wait on the event, and the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.Modify" /> flag to allow threads to call the <see cref="M:System.Threading.EventWaitHandle.Set" /> and <see cref="M:System.Threading.EventWaitHandle.Reset" /> methods. </para>
<para>The <see cref="Overload:System.Threading.EventWaitHandle.OpenExisting" /> method tries to open an existing named system event. If the system event does not exist, this method throws an exception instead of creating the system event. To create the system event when it does not already exist, use one of the <see cref="M:System.Threading.EventWaitHandle.#ctor(System.Boolean,System.Threading.EventResetMode,System.String,System.Boolean@,System.Security.AccessControl.EventWaitHandleSecurity)" /> constructors that has a <paramref name="name" /> parameter.</para>
<para>Multiple calls to this method that use the same value for <paramref name="name" /> do not necessarily return the same <see cref="T:System.Threading.EventWaitHandle" /> object, even though the objects that are returned represent the same named system event. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Opens the specified named synchronization event, if it already exists, with the desired security access.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An object that represents the named system event.</para>
</returns>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the system synchronization event to open.</param>
<param name="rights">
<attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the enumeration values that represent the desired security access.</param>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public bool Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Reset() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the state of the event to nonsignaled, causing threads to block.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the operation succeeds; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public bool Set ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Set() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For an <see cref="T:System.Threading.EventWaitHandle" /> with <see cref="F:System.Threading.EventResetMode.AutoReset" /> (including <see cref="T:System.Threading.AutoResetEvent" />), the <see cref="M:System.Threading.EventWaitHandle.Set" /> method releases a single thread. If there are no waiting threads, the wait handle remains signaled until a thread attempts to wait on it, or until its <see cref="M:System.Threading.EventWaitHandle.Reset" /> method is called.</para>
<block subset="none" type="note">
<para>There is no guarantee that every call to the <see cref="M:System.Threading.EventWaitHandle.Set" /> method will release a thread from an <see cref="T:System.Threading.EventWaitHandle" /> whose reset mode is <see cref="F:System.Threading.EventResetMode.AutoReset" />. If two calls are too close together, so that the second call occurs before a thread has been released, only one thread is released. It is as if the second call did not happen. Also, if <see cref="M:System.Threading.EventWaitHandle.Set" /> is called when there are no threads waiting and the <see cref="T:System.Threading.EventWaitHandle" /> is already signaled, the call has no effect. </para>
</block>
<para>For an <see cref="T:System.Threading.EventWaitHandle" /> with <see cref="F:System.Threading.EventResetMode.ManualReset" /> (including <see cref="T:System.Threading.ManualResetEvent" />), calling the <see cref="M:System.Threading.EventWaitHandle.Set" /> method leaves the wait handle in a signaled state until its <see cref="M:System.Threading.EventWaitHandle.Reset" /> method is called.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the state of the event to signaled, allowing one or more waiting threads to proceed.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the operation succeeds; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="SetAccessControl">
<MemberSignature Language="C#" Value="public void SetAccessControl (System.Security.AccessControl.EventWaitHandleSecurity eventSecurity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAccessControl(class System.Security.AccessControl.EventWaitHandleSecurity eventSecurity) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventSecurity" Type="System.Security.AccessControl.EventWaitHandleSecurity" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The user must have <see cref="F:System.Security.AccessControl.EventWaitHandleRights.ChangePermissions" /> rights to call this method, and the event must have been opened with the <see cref="F:System.Security.AccessControl.EventWaitHandleRights.ChangePermissions" /> flag.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the access control security for a named system event.</para>
</summary>
<param name="eventSecurity">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Security.AccessControl.EventWaitHandleSecurity" /> object that represents the access control security to be applied to the named system event.</param>
</Docs>
</Member>
<Member MemberName="TryOpenExisting">
<MemberSignature Language="C#" Value="public static bool TryOpenExisting (string name, out System.Threading.EventWaitHandle result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryOpenExisting(string name, class System.Threading.EventWaitHandle result) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="result" Type="System.Threading.EventWaitHandle&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryOpenExisting">
<MemberSignature Language="C#" Value="public static bool TryOpenExisting (string name, System.Security.AccessControl.EventWaitHandleRights rights, out System.Threading.EventWaitHandle result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryOpenExisting(string name, valuetype System.Security.AccessControl.EventWaitHandleRights rights, class System.Threading.EventWaitHandle result) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="rights" Type="System.Security.AccessControl.EventWaitHandleRights" />
<Parameter Name="result" Type="System.Threading.EventWaitHandle&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="rights">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>

271
mcs/class/corlib/Documentation/en/System.Threading/ExecutionContext.xml Normal file
View File

@@ -0,0 +1,271 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ExecutionContext" FullName="System.Threading.ExecutionContext">
<TypeSignature Language="C#" Value="public sealed class ExecutionContext : IDisposable, System.Runtime.Serialization.ISerializable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed beforefieldinit ExecutionContext extends System.Object implements class System.IDisposable, class System.Runtime.Serialization.ISerializable" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.ExecutionContext" /> class provides a single container for all information relevant to a logical thread of execution. This includes security context, call context, and synchronization context.</para>
<para>The <see cref="T:System.Threading.ExecutionContext" /> class provides the functionality for user code to capture and transfer this context across user-defined asynchronous points. The common language runtime ensures that the <see cref="T:System.Threading.ExecutionContext" /> is consistently transferred across runtime-defined asynchronous points within the managed process. </para>
<para>An execution context is the managed equivalent of a COM apartment. Within an application domain, the entire execution context must be transferred whenever a thread is transferred. This situation occurs during transfers made by the <see cref="M:System.Threading.Thread.Start" /> method, most thread pool operations, and Windows Forms thread marshaling through the Windows message pump. It does not occur in unsafe thread pool operations (such as the <see cref="M:System.Threading.ThreadPool.UnsafeQueueUserWorkItem(System.Threading.WaitCallback,System.Object)" /> method), which do not transfer the compressed stack. Wherever the compressed stack flows, the managed principal, synchronization, locale, and user context also flow. The <see cref="T:System.Threading.ExecutionContext" /> class provides the <see cref="M:System.Threading.ExecutionContext.Capture" /> and <see cref="M:System.Threading.ExecutionContext.CreateCopy" /> methods to get the execution context and the <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> method to set the execution context for the current thread.</para>
<para>An <see cref="T:System.Threading.ExecutionContext" /> that is associated with a thread cannot be set on another thread. Attempting to do so will result in an exception being thrown. To propagate the <see cref="T:System.Threading.ExecutionContext" /> from one thread to another, make a copy of the <see cref="T:System.Threading.ExecutionContext" />.</para>
<para>Internally, the <see cref="T:System.Threading.ExecutionContext" /> stores all data that is associated with the <see cref="T:System.Runtime.Remoting.Messaging.LogicalCallContext" />. This allows the <see cref="T:System.Runtime.Remoting.Messaging.LogicalCallContext" /> data to be propagated when the <see cref="T:System.Threading.ExecutionContext" /> is copied and transferred.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Manages the execution context for the current thread. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Capture">
<MemberSignature Language="C#" Value="public static System.Threading.ExecutionContext Capture ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.ExecutionContext Capture() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.ExecutionContext</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The captured execution context can be used as the <paramref name="executionContext" /> parameter for the <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Captures the execution context from the current thread.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Threading.ExecutionContext" /> object representing the execution context for the current thread.</para>
</returns>
</Docs>
</Member>
<Member MemberName="CreateCopy">
<MemberSignature Language="C#" Value="public System.Threading.ExecutionContext CreateCopy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.ExecutionContext CreateCopy() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.ExecutionContext</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is useful for propagating an execution context from one thread to another.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a copy of the current execution context.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Threading.ExecutionContext" /> object representing the current execution context.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call Dispose when you are finished using the <see cref="T:System.Threading.ExecutionContext" />. The Dispose method leaves the <see cref="T:System.Threading.ExecutionContext" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.Threading.ExecutionContext" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Threading.ExecutionContext" /> was occupying.</para>
<para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
<block subset="none" type="note">
<para>Always call Dispose before you release your last reference to the <see cref="T:System.Threading.ExecutionContext" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Threading.ExecutionContext" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the current instance of the <see cref="T:System.Threading.ExecutionContext" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="GetObjectData">
<MemberSignature Language="C#" Value="public void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Threading.ExecutionContext.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" /> sets a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the logical call context information. During deserialization, the execution context object is reconstituted from the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> transmitted over the stream.</para>
<para>For more information, see <see cref="T:System.Runtime.Serialization.SerializationInfo" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object with the logical context information needed to recreate an instance of the current execution context.</para>
</summary>
<param name="info">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object to be populated with serialization information. </param>
<param name="context">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.StreamingContext" /> structure representing the destination context of the serialization. </param>
</Docs>
</Member>
<Member MemberName="IsFlowSuppressed">
<MemberSignature Language="C#" Value="public static bool IsFlowSuppressed ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsFlowSuppressed() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Threading.ExecutionContext.IsFlowSuppressed" /> method is used by infrastructure components to determine whether to transfer the <see cref="T:System.Threading.ExecutionContext" /> during asynchronous operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the flow of the execution context is currently suppressed.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the flow is suppressed; otherwise, false. </para>
</returns>
</Docs>
</Member>
<Member MemberName="RestoreFlow">
<MemberSignature Language="C#" Value="public static void RestoreFlow ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void RestoreFlow() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Threading.ExecutionContext.RestoreFlow" /> reverses the effect of a prior <see cref="M:System.Threading.ExecutionContext.SuppressFlow" /> method call.</para>
<para>This method is called by the <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method of the <see cref="T:System.Threading.AsyncFlowControl" /> structure returned by the <see cref="M:System.Threading.ExecutionContext.SuppressFlow" /> method. You should use the <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method to restore the flow of the execution context, not the <see cref="M:System.Threading.ExecutionContext.RestoreFlow" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the flow of the execution context across asynchronous threads.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Run">
<MemberSignature Language="C#" Value="public static void Run (System.Threading.ExecutionContext executionContext, System.Threading.ContextCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Run(class System.Threading.ExecutionContext executionContext, class System.Threading.ContextCallback callback, object state) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="executionContext" Type="System.Threading.ExecutionContext" />
<Parameter Name="callback" Type="System.Threading.ContextCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The execution context is returned to its previous state when the method completes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Runs a method in a specified execution context on the current thread.</para>
</summary>
<param name="executionContext">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.ExecutionContext" /> to set.</param>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Threading.ContextCallback" /> delegate that represents the method to be run in the provided execution context.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />The object to pass to the callback method.</param>
</Docs>
</Member>
<Member MemberName="SuppressFlow">
<MemberSignature Language="C#" Value="public static System.Threading.AsyncFlowControl SuppressFlow ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Threading.AsyncFlowControl SuppressFlow() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.AsyncFlowControl</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to suppress the flow of the <see cref="T:System.Threading.ExecutionContext" /> on the current thread. </para>
<para>You must use the <see cref="M:System.Threading.AsyncFlowControl.Undo" /> method on the returned <see cref="T:System.Threading.AsyncFlowControl" /> structure to restore the flow of the <see cref="T:System.Threading.ExecutionContext" />.</para>
<para>This method is protected with a <see cref="F:System.Security.Permissions.SecurityAction.LinkDemand" /> for <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure" /> permission. A fully trusted component can call this method to suppress the flow of the <see cref="T:System.Threading.ExecutionContext" /> during asynchronous calls. While the flow is suppressed, the <see cref="M:System.Security.SecurityContext.Capture" /> method returns null. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Suppresses the flow of the execution context across asynchronous threads.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Threading.AsyncFlowControl" /> structure for restoring the flow.</para>
</returns>
</Docs>
</Member>
</Members>
</Type>

125
mcs/class/corlib/Documentation/en/System.Threading/HostExecutionContext.xml Normal file
View File

@@ -0,0 +1,125 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HostExecutionContext" FullName="System.Threading.HostExecutionContext">
<TypeSignature Language="C#" Value="public class HostExecutionContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HostExecutionContext extends System.Object" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.HostExecutionContext" /> is part of a larger <see cref="T:System.Threading.ExecutionContext" />. The host context migrates, or flows, with the execution context.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Encapsulates and propagates the host execution context across threads. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HostExecutionContext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default constructor creates a host execution context whose <see cref="P:System.Threading.HostExecutionContext.State" /> property value is null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.HostExecutionContext" /> class. </para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HostExecutionContext (object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object state) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.HostExecutionContext" /> is included with the <see cref="T:System.Threading.ExecutionContext" />. The <paramref name="state" /> represents a safe handle containing the IUnknown pointer for the host.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.HostExecutionContext" /> class using the specified state. </para>
</summary>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />An object representing the host execution context state.</param>
</Docs>
</Member>
<Member MemberName="CreateCopy">
<MemberSignature Language="C#" Value="public virtual System.Threading.HostExecutionContext CreateCopy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.HostExecutionContext CreateCopy() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.HostExecutionContext</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The copy can be used as the parameter to a <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method call.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a copy of the current host execution context.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.HostExecutionContext" /> object representing the host context for the current thread.</para>
</returns>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="protected object State { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Threading.HostExecutionContext.State" /> property value represents a safe handle containing the IUnknown pointer for the host.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the state of the host execution context.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

140
mcs/class/corlib/Documentation/en/System.Threading/HostExecutionContextManager.xml Normal file
View File

@@ -0,0 +1,140 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HostExecutionContextManager" FullName="System.Threading.HostExecutionContextManager">
<TypeSignature Language="C#" Value="public class HostExecutionContextManager" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HostExecutionContextManager extends System.Object" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the current <see cref="T:System.AppDomainManager" /> has a reference to a <see cref="T:System.Threading.HostExecutionContextManager" /> in its <see cref="P:System.AppDomainManager.HostExecutionContextManager" /> property, then the common language runtime calls the manager every time a call to the <see cref="M:System.Threading.ExecutionContext.Run(System.Threading.ExecutionContext,System.Threading.ContextCallback,System.Object)" /> method occurs, to allow the host to participate in the flow of the execution context.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the functionality that allows a common language runtime host to participate in the flow, or migration, of the execution context.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HostExecutionContextManager ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Threading.HostExecutionContextManager" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Capture">
<MemberSignature Language="C#" Value="public virtual System.Threading.HostExecutionContext Capture ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.HostExecutionContext Capture() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.HostExecutionContext</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Threading.HostExecutionContext" /> is created using a safe handle containing the IUnknown pointer for the host executing the current thread.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Captures the host execution context from the current thread.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Threading.HostExecutionContext" /> object representing the host execution context of the current thread.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Revert">
<MemberSignature Language="C#" Value="public virtual void Revert (object previousState);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Revert(object previousState) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.MayFail)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="previousState" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<paramref name="previousState" /> must be the object returned by the <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the host execution context to its prior state.</para>
</summary>
<param name="previousState">
<attribution license="cc4" from="Microsoft" modified="false" />The previous context state to revert to.</param>
</Docs>
</Member>
<Member MemberName="SetHostExecutionContext">
<MemberSignature Language="C#" Value="public virtual object SetHostExecutionContext (System.Threading.HostExecutionContext hostExecutionContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object SetHostExecutionContext(class System.Threading.HostExecutionContext hostExecutionContext) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostExecutionContext" Type="System.Threading.HostExecutionContext" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method sets the host execution context for the current <see cref="T:System.Threading.HostExecutionContext" />. A <see cref="T:System.Threading.HostExecutionContext" /> that has been used as the argument to another <see cref="M:System.Threading.HostExecutionContextManager.SetHostExecutionContext(System.Threading.HostExecutionContext)" /> method call cannot be passed in as the parameter for this method. Instead, use the <see cref="M:System.Threading.HostExecutionContext.CreateCopy" /> method to create a copy of a <see cref="T:System.Threading.HostExecutionContext" /> object and then use the copy to set the host execution context.</para>
<para>Call the <see cref="M:System.Threading.HostExecutionContextManager.Revert(System.Object)" /> method using the object returned by this method to restore the <see cref="T:System.Threading.HostExecutionContext" /> to its previous state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the current host execution context to the specified host execution context.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An object for restoring the <see cref="T:System.Threading.HostExecutionContext" /> to its previous state.</para>
</returns>
<param name="hostExecutionContext">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.HostExecutionContext" /> to be set.</param>
</Docs>
</Member>
</Members>
</Type>

43
mcs/class/corlib/Documentation/en/System.Threading/IOCompletionCallback.xml Normal file
View File

@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IOCompletionCallback" FullName="System.Threading.IOCompletionCallback">
<TypeSignature Maintainer="auto" Language="C#" Value="public delegate void IOCompletionCallback(uint errorCode, uint numBytes, NativeOverlapped* pOVERLAP);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed IOCompletionCallback extends System.MulticastDelegate" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.CLSCompliant(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="errorCode" Type="System.UInt32" />
<Parameter Name="numBytes" Type="System.UInt32" />
<Parameter Name="pOVERLAP" Type="System.Threading.NativeOverlapped*" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="errorCode">To be added.</param>
<param name="numBytes">To be added.</param>
<param name="pOVERLAP">To be added.</param>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Receives the error code, number of bytes, and overlapped value type when an I/O operation completes on the thread pool.</para>
</summary>
</Docs>
<Members />
</Type>

790
mcs/class/corlib/Documentation/en/System.Threading/Interlocked.xml Normal file
View File

File diff suppressed because it is too large Load Diff

141
mcs/class/corlib/Documentation/en/System.Threading/LazyInitializer.xml Normal file
View File

@@ -0,0 +1,141 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="LazyInitializer" FullName="System.Threading.LazyInitializer">
<TypeSignature Language="C#" Value="public static class LazyInitializer" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit LazyInitializer extends System.Object" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>These routines avoid needing to allocate a dedicated, lazy-initialization instance, instead using references to ensure targets have been initialized as they are accessed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides lazy initialization routines.</para>
</summary>
</Docs>
<Members>
<Member MemberName="EnsureInitialized&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T EnsureInitialized&lt;T&gt; (ref T target) where T : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T EnsureInitialized&lt;class T&gt;(!!T target) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="target" Type="T&amp;" RefType="ref" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="target">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureInitialized&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T EnsureInitialized&lt;T&gt; (ref T target, Func&lt;T&gt; valueFactory) where T : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T EnsureInitialized&lt;class T&gt;(!!T target, class System.Func`1&lt;!!T&gt; valueFactory) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="target" Type="T&amp;" RefType="ref" />
<Parameter Name="valueFactory" Type="System.Func&lt;T&gt;" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="target">To be added.</param>
<param name="valueFactory">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureInitialized&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T EnsureInitialized&lt;T&gt; (ref T target, ref bool initialized, ref object syncLock);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T EnsureInitialized&lt;T&gt;(!!T target, bool initialized, object syncLock) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="target" Type="T&amp;" RefType="ref" />
<Parameter Name="initialized" Type="System.Boolean&amp;" RefType="ref" />
<Parameter Name="syncLock" Type="System.Object&amp;" RefType="ref" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="target">To be added.</param>
<param name="initialized">To be added.</param>
<param name="syncLock">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureInitialized&lt;T&gt;">
<MemberSignature Language="C#" Value="public static T EnsureInitialized&lt;T&gt; (ref T target, ref bool initialized, ref object syncLock, Func&lt;T&gt; valueFactory);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T EnsureInitialized&lt;T&gt;(!!T target, bool initialized, object syncLock, class System.Func`1&lt;!!T&gt; valueFactory) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="target" Type="T&amp;" RefType="ref" />
<Parameter Name="initialized" Type="System.Boolean&amp;" RefType="ref" />
<Parameter Name="syncLock" Type="System.Object&amp;" RefType="ref" />
<Parameter Name="valueFactory" Type="System.Func&lt;T&gt;" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="target">To be added.</param>
<param name="initialized">To be added.</param>
<param name="syncLock">To be added.</param>
<param name="valueFactory">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>

132
mcs/class/corlib/Documentation/en/System.Threading/LazyThreadSafetyMode.xml Normal file
View File

@@ -0,0 +1,132 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="LazyThreadSafetyMode" FullName="System.Threading.LazyThreadSafetyMode">
<TypeSignature Language="C#" Value="public enum LazyThreadSafetyMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed LazyThreadSafetyMode extends System.Enum" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this enumeration to specify the <paramref name="mode" /> parameter of <see cref="T:System.Lazy`1" /> constructors. The effects of all constructors on thread synchronization can be described in terms of this enumeration, whether or not they have <paramref name="mode" /> parameters.</para>
<para>A <see cref="T:System.Lazy`1" /> instance is initialized either by a user-specified initialization method or by the default constructor for <paramref name="T" />. The initialization method is specified by the <paramref name="valueFactory" /> parameter of a <see cref="T:System.Lazy`1" /> constructor. The method returns an instance of <paramref name="T" />, which is the type that is lazily instantiated by the instance of <see cref="T:System.Lazy`1" />. If a constructor does not have a <paramref name="valueFactory" /> parameter, the default constructor for <paramref name="T" /> is used to initialize the <see cref="T:System.Lazy`1" /> instance. In either case, initialization occurs the first time you call the <see cref="P:System.Lazy`1.Value" /> property.</para>
<para>In addition to specifying the thread safety of a <see cref="T:System.Lazy`1" /> instance, this enumeration affects exception caching. When exceptions are cached for a <see cref="T:System.Lazy`1" /> instance, you get only one chance to initialize the instance. If an exception is thrown the first time you call the <see cref="P:System.Lazy`1.Value" /> property, that exception is cached and rethrown on all subsequent calls to the <see cref="P:System.Lazy`1.Value" /> property. The advantage of caching exceptions is that any two threads always get the same result, even when errors occur.</para>
<para>When you specify the <see cref="F:System.Threading.LazyThreadSafetyMode.PublicationOnly" /> mode, exceptions are never cached. When you specify <see cref="F:System.Threading.LazyThreadSafetyMode.None" /> or <see cref="F:System.Threading.LazyThreadSafetyMode.ExecutionAndPublication" />, caching depends on whether you specify an initialization method or allow the default constructor for <paramref name="T" /> to be used. Specifying an initialization method enables exception caching for these two modes. The initialization method can be very simple. For example, it might call the default constructor for <paramref name="T" />: new Lazy&lt;Contents&gt;(() =&gt; new Contents(), mode) in C#, or New Lazy(Of Contents)(Function() New Contents()) in Visual Basic. If you use a constructor that does not specify an initialization method, exceptions that are thrown by the default constructor for <paramref name="T" /> are not cached. The following table summarizes exception caching behavior.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Mode</para>
</term>
<description>
<para>Using initialization method</para>
</description>
<description>
<para>Using default constructor for <paramref name="T" /></para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="F:System.Threading.LazyThreadSafetyMode.None" />
</para>
</term>
<description>
<para>Cached</para>
</description>
<description>
<para>Not cached</para>
</description>
</item>
<item>
<term>
<para>
<see cref="F:System.Threading.LazyThreadSafetyMode.PublicationOnly" />
</para>
</term>
<description>
<para>Not cached</para>
</description>
<description>
<para>Not cached</para>
</description>
</item>
<item>
<term>
<para>
<see cref="F:System.Threading.LazyThreadSafetyMode.ExecutionAndPublication" />
</para>
</term>
<description>
<para>Cached</para>
</description>
<description>
<para>Not cached</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies how a <see cref="T:System.Lazy`1" /> instance synchronizes access among multiple threads.</para>
</summary>
</Docs>
<Members>
<Member MemberName="ExecutionAndPublication">
<MemberSignature Language="C#" Value="ExecutionAndPublication" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.LazyThreadSafetyMode ExecutionAndPublication = int32(2)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.LazyThreadSafetyMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Locks are used to ensure that only a single thread can initialize a <see cref="T:System.Lazy`1" /> instance in a thread-safe manner. If the initialization method (or the default constructor, if there is no initialization method) uses locks internally, deadlocks can occur. If you use a <see cref="T:System.Lazy`1" /> constructor that specifies an initialization method (<paramref name="valueFactory" /> parameter), and if that initialization method throws an exception (or fails to handle an exception) the first time you call the <see cref="P:System.Lazy`1.Value" /> property, then the exception is cached and thrown again on subsequent calls to the <see cref="P:System.Lazy`1.Value" /> property. If you use a <see cref="T:System.Lazy`1" /> constructor that does not specify an initialization method, exceptions that are thrown by the default constructor for <paramref name="T" /> are not cached. In that case, a subsequent call to the <see cref="P:System.Lazy`1.Value" /> property might successfully initialize the <see cref="T:System.Lazy`1" /> instance. If the initialization method recursively accesses the <see cref="P:System.Lazy`1.Value" /> property of the <see cref="T:System.Lazy`1" /> instance, an <see cref="T:System.InvalidOperationException" /> is thrown. </para>
</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.LazyThreadSafetyMode None = int32(0)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.LazyThreadSafetyMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Lazy`1" /> instance is not thread safe; if the instance is accessed from multiple threads, its behavior is undefined. Use this mode only when high performance is crucial and the <see cref="T:System.Lazy`1" /> instance is guaranteed never to be initialized from more than one thread. If you use a <see cref="T:System.Lazy`1" /> constructor that specifies an initialization method (<paramref name="valueFactory" /> parameter), and if that initialization method throws an exception (or fails to handle an exception) the first time you call the <see cref="P:System.Lazy`1.Value" /> property, then the exception is cached and thrown again on subsequent calls to the <see cref="P:System.Lazy`1.Value" /> property. If you use a <see cref="T:System.Lazy`1" /> constructor that does not specify an initialization method, exceptions that are thrown by the default constructor for <paramref name="T" /> are not cached. In that case, a subsequent call to the <see cref="P:System.Lazy`1.Value" /> property might successfully initialize the <see cref="T:System.Lazy`1" /> instance. If the initialization method recursively accesses the <see cref="P:System.Lazy`1.Value" /> property of the <see cref="T:System.Lazy`1" /> instance, an <see cref="T:System.InvalidOperationException" /> is thrown.</para>
</summary>
</Docs>
</Member>
<Member MemberName="PublicationOnly">
<MemberSignature Language="C#" Value="PublicationOnly" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Threading.LazyThreadSafetyMode PublicationOnly = int32(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.LazyThreadSafetyMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When multiple threads try to initialize a <see cref="T:System.Lazy`1" /> instance simultaneously, all threads are allowed to run the initialization method (or the default constructor, if there is no initialization method). The first thread to complete initialization sets the value of the <see cref="T:System.Lazy`1" /> instance. That value is returned to any other threads that were simultaneously running the initialization method, unless the initialization method throws exceptions on those threads. Any instances of <paramref name="T" /> that were created by the competing threads are discarded. If the initialization method throws an exception on any thread, the exception is propagated out of the <see cref="P:System.Lazy`1.Value" /> property on that thread. The exception is not cached. The value of the <see cref="P:System.Lazy`1.IsValueCreated" /> property remains false, and subsequent calls to the <see cref="P:System.Lazy`1.Value" /> property, either by the thread where the exception was thrown or by other threads, cause the initialization method to run again. If the initialization method recursively accesses the <see cref="P:System.Lazy`1.Value" /> property of the <see cref="T:System.Lazy`1" /> instance, no exception is thrown.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

176
mcs/class/corlib/Documentation/en/System.Threading/LockCookie.xml Normal file
View File

@@ -0,0 +1,176 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="LockCookie" FullName="System.Threading.LockCookie">
<TypeSignature Maintainer="auto" Language="C#" Value="public struct LockCookie" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit LockCookie extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the lock that implements single-writer/multiple-reader semantics. This is a value type.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether a specified object is a <see cref="T:System.Threading.LockCookie" /> and is equal to the current instance.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the value of <paramref name="obj" /> is equal to the value of the current instance; otherwise, false.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />The object to compare to the current instance.</param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (System.Threading.LockCookie obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype System.Threading.LockCookie obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Threading.LockCookie" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the current instance is equal to the specified <see cref="T:System.Threading.LockCookie" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="obj" /> is equal to the value of the current instance; otherwise, false.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.LockCookie" /> to compare to the current instance.</param>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the hash code for this instance.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A 32-bit signed integer hash code.</para>
</returns>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Threading.LockCookie a, System.Threading.LockCookie b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Threading.LockCookie a, valuetype System.Threading.LockCookie b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.Threading.LockCookie" />
<Parameter Name="b" Type="System.Threading.LockCookie" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether two <see cref="T:System.Threading.LockCookie" /> structures are equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="a" /> is equal to <paramref name="b" />; otherwise, false.</para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.LockCookie" /> to compare to <paramref name="b" />.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.LockCookie" /> to compare to <paramref name="a" />.</param>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Threading.LockCookie a, System.Threading.LockCookie b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Threading.LockCookie a, valuetype System.Threading.LockCookie b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.Threading.LockCookie" />
<Parameter Name="b" Type="System.Threading.LockCookie" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether two <see cref="T:System.Threading.LockCookie" /> structures are not equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="a" /> is not equal to <paramref name="b" />; otherwise, false.</para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.LockCookie" /> to compare to <paramref name="b" />.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Threading.LockCookie" /> to compare to <paramref name="a" />.</param>
</Docs>
</Member>
</Members>
</Type>

Some files were not shown because too many files have changed in this diff Show More