Update Method (SamplePlan)

• Visual Basic
• C#

'Declaration
 
Public Shared Sub Update( _
   ByVal sessionId As Integer, _
   ByVal planId As Integer, _
   ByVal planName As String, _
   ByVal planDesc As DBString, _
   ByVal categoryId As DBInt, _
   ByVal verifiedWrite As Boolean, _
   ByVal samplePlan As String, _
   ByVal resetOption As Integer, _
   ByVal spare1 As DBString, _
   ByVal spare2 As DBString, _
   ByVal spare3 As DBString, _
   ByVal spare4 As DBString, _
   ByVal lastEditComment As DBString, _
   ByRef lastEditAt As Date _
) 

'Usage
 
Dim sessionId As Integer
Dim planId As Integer
Dim planName As String
Dim planDesc As DBString
Dim categoryId As DBInt
Dim verifiedWrite As Boolean
Dim samplePlan As String
Dim resetOption As Integer
Dim spare1 As DBString
Dim spare2 As DBString
Dim spare3 As DBString
Dim spare4 As DBString
Dim lastEditComment As DBString
Dim lastEditAt As Date
 
SamplePlan.Update(sessionId, planId, planName, planDesc, categoryId, verifiedWrite, samplePlan, resetOption, spare1, spare2, spare3, spare4, lastEditComment, lastEditAt)

public static void Update( 
   int sessionId,
   int planId,
   string planName,
   DBString planDesc,
   DBInt categoryId,
   bool verifiedWrite,
   string samplePlan,
   int resetOption,
   DBString spare1,
   DBString spare2,
   DBString spare3,
   DBString spare4,
   DBString lastEditComment,
   ref DateTime lastEditAt
)

Parameters

sessionId

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

planId

Required. Holds the ID of the sample plan.

planName

Required. Holds the unique name of the sample plan for display.

planDesc

Required. Holds a description of the sample plan.

categoryId

Required. Holds the ID of the category the sample plan belongs to.

verifiedWrite

Required. Holds a flag indicating if an operator confirmation of manually entered values is required.

samplePlan

Required. Holds the pattern sample names are to follow.

resetOption

Optional. Holds the option for reseting the octothorpe part(#) of a sample plan name back to 1. Default is Never. 0 (default) = nothing (never resets), 1 = change in local date.

spare1

Required. Holds the contents of the user-defined spare1 field.

spare2

Required. Holds the contents of the user-defined spare2 field.

spare3

Required. Holds the contents of the user-defined spare3 field.

spare4

Required. Holds the contents of the user-defined spare4 field.

lastEditComment

Required. Holds the new comment that describes why this record is being updated.

lastEditAt

In/Out parameter. Holds datetime of when record was created or last changed.