(Object, SPWorkflowAssociation, String, SPWorkflowRunOptions) del método SPWorkflowManager.StartWorkflow
Crea e inicia una nueva instancia de flujo de trabajo en un objeto especificado, basado en una asociación de flujo de trabajo determinado, con parámetros de evento especificados y con las opciones especificadas para la ejecución de la instancia de flujo de trabajo.
Espacio de nombres: Microsoft.SharePoint.Workflow
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
Public Function StartWorkflow ( _
context As Object, _
association As SPWorkflowAssociation, _
eventData As String, _
runOptions As SPWorkflowRunOptions _
) As SPWorkflow
'Uso
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
)
Parámetros
context
Tipo: System.ObjectObjeto en el que se ejecuta el flujo de trabajo.
association
Tipo: Microsoft.SharePoint.Workflow.SPWorkflowAssociationLa asociación de flujo de trabajo en el que desea basar la nueva instancia de flujo de trabajo.
eventData
Tipo: System.StringUna cadena que contiene los parámetros de evento.
runOptions
Tipo: Microsoft.SharePoint.Workflow.SPWorkflowRunOptionsValor de enumeración que especifica cómo se debe ejecutar la instancia de flujo de trabajo.
Si el argumento es RunOptions.Synchronous, el método intenta iniciar el flujo de trabajo inmediatamente; Si no se puede iniciar inmediatamente, el método devuelve una referencia null (Nothing en Visual Basic).
Si el argumento es RunOptions.SynchronousAllowPostpone, el método intenta iniciar el flujo de trabajo inmediatamente; Si no se puede iniciar inmediatamente, está aplazada y el método devuelve un objeto de SPWorkflow que hace referencia el flujo de trabajo no han comenzado.
Si el argumento es RunOptions.Asynchronous, entonces se aplaza el inicio del flujo de trabajo y el método devuelve un objeto de SPWorkflow que hace referencia el flujo de trabajo no han comenzado.
Valor devuelto
Tipo: Microsoft.SharePoint.Workflow.SPWorkflow
La nueva instancia de flujo de trabajo o una referencia null (Nothing en Visual Basic), según el argumento para el parámetro runOptions .
Excepciones
Excepción | Condición |
---|---|
ArgumentNullException | El argumento para el parámetro del elemento o la asociación es una referencia null (Nothing en Visual Basic). |
ArgumentException | La asociación de flujo de trabajo pasada al parámetro de asociación no es compatible con el elemento de lista que se pasa al parámetro de elemento. El elemento podría tener el contenido equivocado escriba o pertenecen a un tipo de lista incorrecto. O el tipo de contenido del elemento se deriva del tipo de contenido de WorkflowTask , pero la propiedad IsDeclarative de la asociación de flujo de trabajo es false; flujos de trabajo declarativos pueden iniciarse en un elemento de tarea. Un ArgumentException también se produce si la propiedad Enabled de la asociación flujo de trabajo es false. |
UnauthorizedAccessException | El usuario actual tiene permisos suficientes para iniciar el flujo de trabajo. |
SPException | El elemento está bloqueado debido a un bloqueo a corto plazo o desprotección. |