StopStep(Int32,String,String,String,Int32,String,String,Nullable<Int32>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Int32>) Method

• Visual Basic
• C#

'Declaration
 
Public Overloads Shared Sub StopStep( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal stepNo As Integer, _
   ByVal lotNo As String, _
   ByVal subLotNo As String, _
   ByVal stateCd As Nullable(Of Integer), _
   ByVal checkCert As Nullable(Of Boolean), _
   ByVal laborOption As Nullable(Of Boolean), _
   ByVal jobPos As Nullable(Of Integer) _
) 

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim entName As String
Dim siteName As String
Dim stepNo As Integer
Dim lotNo As String
Dim subLotNo As String
Dim stateCd As Nullable(Of Integer)
Dim checkCert As Nullable(Of Boolean)
Dim laborOption As Nullable(Of Boolean)
Dim jobPos As Nullable(Of Integer)
 
JobExec.StopStep(sessionId, userId, entName, siteName, stepNo, lotNo, subLotNo, stateCd, checkCert, laborOption, jobPos)

public static void StopStep( 
   int sessionId,
   string userId,
   string entName,
   string siteName,
   int stepNo,
   string lotNo,
   string subLotNo,
   Nullable<int> stateCd,
   Nullable<bool> checkCert,
   Nullable<bool> laborOption,
   Nullable<int> jobPos
)

Parameters

sessionId

Required. Holds the ID of the session from which the call is being made.

userId

Required. Holds the ID of the user who is working on the step.

entName

Required. Holds the name of the entity on which the step is being run. This will identify the job that contains the step.

siteName

Optional. Holds the site name of the entity.

stepNo

Required. Holds the number of the step that is being stopped.

lotNo

Required. Holds the lot number on which this step is being performed.

subLotNo

Optional. Holds the sublot number on which this step is being performed.

stateCd

Optional. Holds the state of the step. The only valid state codes are 3 (Running) or 8 (Bypassed). Default is Running.

checkCert

Optional. Holds a flag that, if set to true, specifies that the user’s certifications should be checked before starting the job (requires the Certification module). Default is false.

laborOption

Optional. Holds a flag that, if set to true, specifies that labor usage be captured by the step. Default is false. (Requires the Labor option to be licensed.)

jobPos

Optional. Holds the job position. If greater than 1, jobs are running on this entity.