Update Method (JobState)

• Visual Basic
• C#

'Declaration
 
Public Shared Sub Update( _
   ByVal sessionId As Integer, _
   ByVal stateCode As Integer, _
   ByVal stateDescription As String, _
   ByVal color As Integer, _
   ByVal lastEditComment As DBString, _
   ByRef lastEditAt As Date _
) 

'Usage
 
Dim sessionId As Integer
Dim stateCode As Integer
Dim stateDescription As String
Dim color As Integer
Dim lastEditComment As DBString
Dim lastEditAt As Date
 
JobState.Update(sessionId, stateCode, stateDescription, color, lastEditComment, lastEditAt)

public static void Update( 
   int sessionId,
   int stateCode,
   string stateDescription,
   int color,
   DBString lastEditComment,
   ref DateTime lastEditAt
)

Parameters

sessionId

Required. Holds the session ID and thus the user who is making this method call.

stateCode

Required. Holds the code of the job or step state.

stateDescription

Required. Holds the description of the job or step state.

color

Required. Holds an RGB color code value of the job or step state.

lastEditComment

Required. Holds comments that describe why this record is being updated.

lastEditAt

Required. Holds the date/time when this record was added or last edited, for optimistic concurrency control. The passed value must match the lastEditAt value in the record for the update to succeed.

Output. Holds the date/time value when this record was updated by this called method.