Show/Hide Toolbars

Therefore Programming Interface 3.0

Claims the workflow instance.

 

Namespace: Therefore.API

 

Visual Basic

Public Overridable Function ClaimInstance ( _

    pServer As TheServer _

) As String

C#

public virtual string ClaimInstance (

    TheServer pServer

)

 

Parameters

pServer

A valid and connected TheServer object.

 

Return Value

If already claimed, the username of the user who has currently claimed the instance is returned. Otherwise an empty string is returned.

 

Exception

Condition

Null Reference Argument

pServer parameter is a null reference / null pointer.

Invalid Server

pServer does not refer to a valid and connected Therefore™ server.

Instance Not Loaded

No workflow instance definition has been loaded from the server.

 

Requires Loaded Instance

Load an instance definition from the server before calling this method.

 

TheServer class

TheWFInstance class

TheWFInstance methods