SPWorkflow.CreateHistoryEvent method (Int32, Object, SPMember, String, String, String)

  • Article

Writes a workflow history event to the specified workflow history list.

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

Syntax

'Declaration
Public Sub CreateHistoryEvent ( _
    eventId As Integer, _
    groupId As Object, _
    user As SPMember, _
    outcome As String, _
    description As String, _
    otherData As String _
)
'Usage
Dim instance As SPWorkflow
Dim eventId As Integer
Dim groupId As Object
Dim user As SPMember
Dim outcome As String
Dim description As String
Dim otherData As String

instance.CreateHistoryEvent(eventId, _
    groupId, user, outcome, description, _
    otherData)

public void CreateHistoryEvent(
    int eventId,
    Object groupId,
    SPMember user,
    string outcome,
    string description,
    string otherData
)

Parameters

  • groupId
    Type: System.Object

    The ID of the group to which this workflow history event belongs.

  • outcome
    Type: System.String

    A description of the workflow event, limited to 255 characters. This information is displayed on the workflow status page.

  • description
    Type: System.String

    A longer description of the workflow event. This information is displayed on the workflow status page.

  • otherData
    Type: System.String

    Any other data to be captured about the workflow history event. This information is not displayed on the workflow status page.

Exceptions

Exception Condition
ArgumentException

groupId is not an int.

Remarks

The eventId parameter takes an enumerated type, based on the SPWorkflowHistoryEventType enumeration.

See also

Reference

SPWorkflow class

SPWorkflow members

CreateHistoryEvent overload

Microsoft.SharePoint.Workflow namespace

Other resources

Workflows in Windows SharePoint Services

Workflow Development for Windows SharePoint Services

Workflow Object Model in Windows SharePoint Services Overview