SPWorkflowManager.StartWorkflow - Méthode (SPListItem, SPWorkflowAssociation, String, Boolean)

Article
05/11/2015

Crée et démarre une nouvelle instance de flux de travail sur un élément de liste spécifié, basé sur une association de flux de travail spécifié, avec les paramètres d'événement spécifiés et éventuellement indique si ce flux de travail démarre automatiquement ou manuellement.

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

Syntaxe

'Déclaration
Public Function StartWorkflow ( _
    item As SPListItem, _
    association As SPWorkflowAssociation, _
    eventData As String, _
    isAutoStart As Boolean _
) As SPWorkflow
'Utilisation
Dim instance As SPWorkflowManager
Dim item As SPListItem
Dim association As SPWorkflowAssociation
Dim eventData As String
Dim isAutoStart As Boolean
Dim returnValue As SPWorkflow

returnValue = instance.StartWorkflow(item, _
    association, eventData, isAutoStart)

public SPWorkflow StartWorkflow(
    SPListItem item,
    SPWorkflowAssociation association,
    string eventData,
    bool isAutoStart
)

Paramètres

item
Type : Microsoft.SharePoint.SPListItem

L'élément de liste auquel démarrer l'instance de workflow.

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.

isAutoStart
Type : System.Boolean

Si l'argument est true, la méthode essaie de démarrer le flux de travail immédiatement ; s'il ne peut pas être exécuté immédiatement, puis le début est différé et une SPWorkflow référençant le flux de travail non commencée est retourné. Si l'argument est false, la méthode essaie de démarrer le flux de travail immédiatement ; s'il ne peut pas être exécuté immédiatement, une référence Null (Rien dans Visual Basic) est retourné.

Valeur renvoyée

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

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é de WorkflowTask contenu type, 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.