SPWorkflowManager.StartWorkflow method (Object, SPWorkflowAssociation, String, SPWorkflowRunOptions)

Artigo
05/12/2015

Cria e inicia uma nova instância de fluxo de trabalho em um objeto específico, com base em uma associação de fluxo de trabalho especificado, com parâmetros de evento especificado e com as opções especificadas para executar a instância do fluxo de trabalho.

Namespace: Microsoft.SharePoint.Workflow
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
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
Type: System.Object

O objeto no qual será executado o fluxo de trabalho.

association
Type: Microsoft.SharePoint.Workflow.SPWorkflowAssociation

A associação de fluxo de trabalho no qual basear a nova instância de fluxo de trabalho.

eventData
Type: System.String

Uma seqüência de caracteres que contém os parâmetros de evento.

runOptions
Type: Microsoft.SharePoint.Workflow.SPWorkflowRunOptions

Um valor de enumeração que especifica como a instância de fluxo de trabalho deverá ser executado.

Se o argumento for RunOptions.Synchronous, o método tenta iniciar o fluxo de trabalho imediatamente; Se não puder ser iniciado imediatamente, o método retorna a null reference (Nothing in Visual Basic).

Se o argumento for RunOptions.SynchronousAllowPostpone, o método tenta iniciar o fluxo de trabalho imediatamente; Se não puder ser iniciado imediatamente, é adiada e o método retornará um objeto de SPWorkflow referenciando o fluxo de trabalho não iniciado.

Se o argumento for RunOptions.Asynchronous, o início do fluxo de trabalho é adiado e o método retorna um objeto de SPWorkflow referenciando o fluxo de trabalho não iniciado.

Valor retornado

Type: Microsoft.SharePoint.Workflow.SPWorkflow
A nova instância de fluxo de trabalho ou a null reference (Nothing in Visual Basic), dependendo do argumento para o parâmetro runOptions .

Exceptions

Exception	Condition
ArgumentNullException	O argumento para o parâmetro do item ou o parâmetro de associação é a null reference (Nothing in Visual Basic).
ArgumentException	A associação de fluxo de trabalho passada para o parâmetro de associação não é compatível com o item passado para o parâmetro de item da lista. O item pode ter conteúdo incorreto digite ou pertencem ao tipo errado de lista. Ou o tipo de conteúdo do item é derivado do tipo de conteúdo WorkflowTask , mas a propriedade IsDeclarative da associação de fluxo de trabalho é false; apenas fluxos de trabalho podem ser iniciados em um item de tarefa. Um ArgumentException também é lançada se Enabled propriedade a associação de fluxo de trabalho for false.
UnauthorizedAccessException	O usuário atual tem permissões insuficientes para iniciar o fluxo de trabalho.
SPException	O item está bloqueado no momento devido a um bloqueio de curta duração ou check-out.

Ver também

Referência

SPWorkflowManager class

SPWorkflowManager members

StartWorkflow overload

Microsoft.SharePoint.Workflow namespace

Compartilhar via