mcs/class/corlib/Documentation/en/System.Runtime.CompilerServices/TaskAwaiter.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="TaskAwaiter" FullName="System.Runtime.CompilerServices.TaskAwaiter">
   3   <TypeSignature Language="C#" Value="public struct TaskAwaiter : System.Runtime.CompilerServices.ICriticalNotifyCompletion" />
   4   <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit TaskAwaiter extends System.ValueType implements class System.Runtime.CompilerServices.ICriticalNotifyCompletion, class System.Runtime.CompilerServices.INotifyCompletion" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.ValueType</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.Runtime.CompilerServices.ICriticalNotifyCompletion</InterfaceName>
  15     </Interface>
  16   </Interfaces>
  17   <Docs>
  18     <remarks>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>This type and its members are intended for use by the compiler.</para>
  21     </remarks>
  22     <summary>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>Provides an object that waits for the completion of an asynchronous task.</para>
  25     </summary>
  26   </Docs>
  27   <Members>
  28     <Member MemberName="GetResult">
  29       <MemberSignature Language="C#" Value="public void GetResult ();" />
  30       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetResult() cil managed" />
  31       <MemberType>Method</MemberType>
  32       <AssemblyInfo>
  33         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  34       </AssemblyInfo>
  35       <ReturnValue>
  36         <ReturnType>System.Void</ReturnType>
  37       </ReturnValue>
  38       <Parameters />
  39       <Docs>
  40         <remarks>
  41           <attribution license="cc4" from="Microsoft" modified="false" />
  42           <para>This type and its members are intended for use by the compiler.</para>
  43         </remarks>
  44         <summary>
  45           <attribution license="cc4" from="Microsoft" modified="false" />
  46           <para>Ends the wait for the completion of the asynchronous task.</para>
  47         </summary>
  48       </Docs>
  49     </Member>
  50     <Member MemberName="IsCompleted">
  51       <MemberSignature Language="C#" Value="public bool IsCompleted { get; }" />
  52       <MemberSignature Language="ILAsm" Value=".property instance bool IsCompleted" />
  53       <MemberType>Property</MemberType>
  54       <AssemblyInfo>
  55         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  56       </AssemblyInfo>
  57       <ReturnValue>
  58         <ReturnType>System.Boolean</ReturnType>
  59       </ReturnValue>
  60       <Docs>
  61         <value>To be added.</value>
  62         <remarks>
  63           <attribution license="cc4" from="Microsoft" modified="false" />
  64           <para>This type and its members are intended for use by the compiler.</para>
  65         </remarks>
  66         <summary>
  67           <attribution license="cc4" from="Microsoft" modified="false" />
  68           <para>Gets a value that indicates whether the asynchronous task has completed.</para>
  69         </summary>
  70       </Docs>
  71     </Member>
  72     <Member MemberName="OnCompleted">
  73       <MemberSignature Language="C#" Value="public void OnCompleted (Action continuation);" />
  74       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnCompleted(class System.Action continuation) cil managed" />
  75       <MemberType>Method</MemberType>
  76       <AssemblyInfo>
  77         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  78       </AssemblyInfo>
  79       <ReturnValue>
  80         <ReturnType>System.Void</ReturnType>
  81       </ReturnValue>
  82       <Parameters>
  83         <Parameter Name="continuation" Type="System.Action" />
  84       </Parameters>
  85       <Docs>
  86         <remarks>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>This type and its members are intended for use by the compiler.</para>
  89         </remarks>
  90         <summary>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>Sets the action to perform when the <see cref="T:System.Runtime.CompilerServices.TaskAwaiter" /> object stops waiting for the asynchronous task to complete.</para>
  93         </summary>
  94         <param name="continuation">
  95           <attribution license="cc4" from="Microsoft" modified="false" />The action to perform when the wait operation completes.</param>
  96       </Docs>
  97     </Member>
  98     <Member MemberName="UnsafeOnCompleted">
  99       <MemberSignature Language="C#" Value="public void UnsafeOnCompleted (Action continuation);" />
 100       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UnsafeOnCompleted(class System.Action continuation) cil managed" />
 101       <MemberType>Method</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.Void</ReturnType>
 107       </ReturnValue>
 108       <Parameters>
 109         <Parameter Name="continuation" Type="System.Action" />
 110       </Parameters>
 111       <Docs>
 112         <remarks>To be added.</remarks>
 113         <summary>
 114           <attribution license="cc4" from="Microsoft" modified="false" />
 115           <para>Schedules the continuation action for the asynchronous task that is associated with this awaiter.</para>
 116         </summary>
 117         <param name="continuation">
 118           <attribution license="cc4" from="Microsoft" modified="false" />The action to invoke when the await operation completes.</param>
 119       </Docs>
 120     </Member>
 121   </Members>
 122 </Type>