SPWorkflowManager.StartWorkflow - Méthode (Object, SPWorkflowAssociation, String, SPWorkflowRunOptions)

Article
05/11/2015

Crée et démarre une nouvelle instance de flux de travail sur un objet spécifié selon une association de flux de travail spécifié, avec les paramètres d'événement spécifiés et avec les options spécifiées pour l'instance de workflow en cours d'exécution.

Espace de noms : Microsoft.SharePoint.Workflow
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function StartWorkflow ( _
    context As Object, _
    association As SPWorkflowAssociation, _
    eventData As String, _
    runOptions As SPWorkflowRunOptions _
) As SPWorkflow
'Utilisation
Dim instance As SPWorkflowManager
Dim context As Object
Dim association As SPWorkflowAssociation
Dim eventData As String
Dim runOptions As SPWorkflowRunOptions
Dim returnValue As SPWorkflow

returnValue = instance.StartWorkflow(context, _
    association, eventData, runOptions)

public SPWorkflow StartWorkflow(
    Object context,
    SPWorkflowAssociation association,
    string eventData,
    SPWorkflowRunOptions runOptions
)

Paramètres

context
Type : System.Object

L'objet sur lequel exécuter le flux de travail.

association
Type : Microsoft.SharePoint.Workflow.SPWorkflowAssociation

L'association de flux de travail sur lequel baser la nouvelle instance de flux de travail.

eventData
Type : System.String

Chaîne qui contient les paramètres d'événement.

runOptions
Type : Microsoft.SharePoint.Workflow.SPWorkflowRunOptions

Valeur d'énumération qui spécifie comment l'instance de workflow doit exécuter.

Si l'argument est RunOptions.Synchronous, la méthode essaie de démarrer le flux de travail immédiatement ; s'il ne peut pas être exécuté immédiatement, la méthode retourne une référence Null (Rien dans Visual Basic).

Si l'argument est RunOptions.SynchronousAllowPostpone, la méthode essaie de démarrer le flux de travail immédiatement ; s'il ne peut pas être exécuté immédiatement, il est différé, et la méthode retourne un objet SPWorkflow qui référence le flux de travail non commencée.

Si l'argument est RunOptions.Asynchronous, puis le début du flux de travail est différé et la méthode retourne un objet SPWorkflow qui référence le flux de travail non commencée.

Valeur renvoyée

Type : Microsoft.SharePoint.Workflow.SPWorkflow
La nouvelle instance de workflow ou une référence Null (Rien dans Visual Basic), selon l'argument pour le paramètre runOptions .

Exceptions

Exception	Condition
ArgumentNullException	L'argument pour le paramètre de l'élément ou l'association est une référence Null (Rien dans Visual Basic).
ArgumentException	L'association de flux de travail passée au paramètre d'association n'est pas compatible avec l'élément de la liste passée au paramètre de l'élément. L'élément peut avoir un contenu erroné tapez ou appartenir à un type de liste incorrect. Ou le type de contenu de l'élément est dérivé du type de contenu de WorkflowTask , mais la propriété IsDeclarative de l'association de flux de travail est false; Seuls les flux de travail déclaratifs peut être démarré sur un élément de tâche. Un ArgumentException est également levée si la propriété Enabled de l'association de flux de travail est false.
UnauthorizedAccessException	L'utilisateur actuel dispose d'autorisations suffisantes pour démarrer le flux de travail.
SPException	L'élément est actuellement verrouillé en raison d'un verrou à court terme ou d'extraction.

Voir aussi

Référence

SPWorkflowManager classe

SPWorkflowManager - Membres

StartWorkflow - Surcharge

Microsoft.SharePoint.Workflow - Espace de noms

Partager via