SPWorkflow.CompareTo Method

Compares this instance to a specified SPWorkflow object.

Namespace:  Microsoft.SharePoint.Workflow
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Function CompareTo ( _
    wf As SPWorkflow _
) As Integer
'Usage
Dim instance As SPWorkflow
Dim wf As SPWorkflow
Dim returnValue As Integer

returnValue = instance.CompareTo(wf)

public int CompareTo(
    SPWorkflow wf
)

Parameters

• wf
  Type: Microsoft.SharePoint.Workflow.SPWorkflow

  The workflow to compare to this instance.

Return Value

Type: System.Int32
A signed number that indicates the relative values of this instance ID and the wf ID.

Return value	Description
A negative integer	This instance ID is less than the wf ID.
zero	This instance ID is equal to the wf ID.
A positive integer	This instance ID is greater than the wf ID.

Implements

IComparable<T>.CompareTo(T)

Remarks

This method compares this workflow instance ID with the wf instance ID and returns an indication of their relative values.

See Also

Reference

SPWorkflow Class

SPWorkflow Members

Microsoft.SharePoint.Workflow Namespace

Other Resources

Workflows in SharePoint Foundation

Workflow Development for SharePoint Foundation

Workflow Object Model Overview in SharePoint Foundation