OrganizationServiceContextExtensions.BulkDelete Method (OrganizationServiceContext, QueryExpression[], String, Boolean, Guid[], Guid[], String, DateTime, Nullable<Guid>)

 

Applies To: Dynamics CRM 2013

Submits an asynchronous bulk delete job. (Developer Extensions)

Namespace:   Microsoft.Xrm.Client.Messages
Assembly:  Microsoft.Xrm.Client (in Microsoft.Xrm.Client.dll)

Syntax

public static Guid BulkDelete(
    this OrganizationServiceContext context,
    QueryExpression[] querySet,
    string jobName,
    bool sendEmailNotification,
    Guid[] toRecipients,
    Guid[] cCRecipients,
    string recurrencePattern,
    DateTime startDateTime,
    Nullable<Guid> sourceImportId
)

public:
[ExtensionAttribute]
static Guid BulkDelete(
    OrganizationServiceContext^ context,
    array<QueryExpression^>^ querySet,
    String^ jobName,
    bool sendEmailNotification,
    array<Guid>^ toRecipients,
    array<Guid>^ cCRecipients,
    String^ recurrencePattern,
    DateTime startDateTime,
    Nullable<Guid> sourceImportId
)

static member BulkDelete : 
        context:OrganizationServiceContext *
        querySet:QueryExpression[] *
        jobName:string *
        sendEmailNotification:bool *
        toRecipients:Guid[] *
        cCRecipients:Guid[] *
        recurrencePattern:string *
        startDateTime:DateTime *
        sourceImportId:Nullable<Guid> -> Guid

<ExtensionAttribute>
Public Shared Function BulkDelete (
    context As OrganizationServiceContext,
    querySet As QueryExpression(),
    jobName As String,
    sendEmailNotification As Boolean,
    toRecipients As Guid(),
    cCRecipients As Guid(),
    recurrencePattern As String,
    startDateTime As Date,
    sourceImportId As Nullable(Of Guid)
) As Guid

Parameters

• context
  Type: Microsoft.Xrm.Sdk.Client.OrganizationServiceContext

  The organization service context.

• querySet
  Type: Microsoft.Xrm.Sdk.Query.QueryExpression[]

  An array of queries for a bulk delete job.

• jobName
  Type: System.String

  The name of an asynchronous bulk delete job.

• sendEmailNotification
  Type: System.Boolean

  Indicates whether an email notification is sent after the bulk delete job has finished running.

• toRecipients
  Type: System.Guid[]

• cCRecipients
  Type: System.Guid[]

  An array of IDs for the system users (users) who are listed in the Cc box of the email notification.

• recurrencePattern
  Type: System.String

  The recurrence pattern for the bulk delete job.

• startDateTime
  Type: System.DateTime

• sourceImportId
  Type: System.Nullable<Guid>

Return Value

Type: System.Guid

Returns a Guid, the ID of an asynchronous bulk delete job that performs a bulk deletion.

Remarks

This is a method wrapper for the BulkDeleteRequest and BulkDeleteResponse classes. See the documentation in the Request class for more information about this message.

See Also

OrganizationServiceContextExtensions Class
Microsoft.Xrm.Client.Messages Namespace
Developer extensions for Microsoft Dynamics CRM 2013

Return to top