IWorkBatch.xml

<Type Name="IWorkBatch" FullName="System.Workflow.Runtime.IWorkBatch">
  <TypeSignature Language="C#" Value="public interface IWorkBatch" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IWorkBatch" />
  <TypeSignature Language="DocId" Value="T:System.Workflow.Runtime.IWorkBatch" />
  <TypeSignature Language="VB.NET" Value="Public Interface IWorkBatch" />
  <TypeSignature Language="F#" Value="type IWorkBatch = interface" />
  <TypeSignature Language="C++ CLI" Value="public interface class IWorkBatch" />
  <AssemblyInfo>
    <AssemblyName>System.Workflow.Runtime</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
      <AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides methods to add work to a work batch.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
  
> [!NOTE]
>  [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]  
  
 Services use this interface to add pending work to the <xref:System.Workflow.Runtime.WorkflowEnvironment.WorkBatch%2A>.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (System.Workflow.Runtime.IPendingWork work, object workItem);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(class System.Workflow.Runtime.IPendingWork work, object workItem) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.IWorkBatch.Add(System.Workflow.Runtime.IPendingWork,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Add (work As IPendingWork, workItem As Object)" />
      <MemberSignature Language="F#" Value="abstract member Add : System.Workflow.Runtime.IPendingWork * obj -&gt; unit" Usage="iWorkBatch.Add (work, workItem)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void Add(System::Workflow::Runtime::IPendingWork ^ work, System::Object ^ workItem);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Workflow.Runtime</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="work" Type="System.Workflow.Runtime.IPendingWork" />
        <Parameter Name="workItem" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="work">An <see cref="T:System.Workflow.Runtime.IPendingWork" /> object associated with the <paramref name="workItem" />.</param>
        <param name="workItem">An object on which work is to be performed.</param>
        <summary>Adds a pending work item to a work batch.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This method is used to add pending work items to a work batch. The `workItem` object added to the batch is associated with `work`, an object that implements the <xref:System.Workflow.Runtime.IPendingWork> interface. Methods provided by this <xref:System.Workflow.Runtime.IPendingWork> object will be called to handle the eventual commit of the `workItem`. Services use this method to add pending work to the <xref:System.Workflow.Runtime.WorkflowEnvironment.WorkBatch%2A>.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>