GetConfirmation Method
- Last UpdatedNov 06, 2025
- 2 minute read
The GetConfirmation() method prompts the user to confirm the selected job state, and returns the prompt response. Permitted actions are Starting, Pausing, and Ending jobs. Status notes are passed by reference in case the user modifies them when changing the job state.
'Declaration
Public Shared Function GetConfirmation( _
ByVal jobState As JobStates, _
ByVal action As String, _
ByVal woDesc As String, _
ByVal operId As String, _
ByVal jobDesc As String, _
ByRef statusNotes As String, _
ByVal userCanAppend As Boolean, _
ByVal userCanEdit As Boolean, _
ByVal batchJobs As Boolean _
) As Boolean
public static bool GetConfirmation(
JobStates jobState,
string action,
string woDesc,
string operId,
string jobDesc,
ref string statusNotes,
bool userCanAppend,
bool userCanEdit,
bool batchJobs
)
Parameters
- jobState
- Required. Holds the job state into which the user wants to put the job.
- action
Required. Holds the action the user wants to perform. These actions include Start, Pause, and End.
- woDesc
- Required. Holds the description of the work order that this job is performing.
- operId
- Required. Holds the operation ID of the job for which the user is confirming the specified action.
- jobDesc
- Required. Holds the description of the job for which the user is confirming the specified action.
- statusNotes
- Required. Holds the statusNotes of the job for which the user is confirming the specified action. If the user has the privileges for appending or editing notes, these notes can be edited when performing one of the specified actions as the status of the job is being changed.
- userCanAppend
- Required. Holds a flag that, if set to true, indicates that the user can append to the status notes of the job. This means that the user can add to the notes that are already present, but cannot delete anything that was previously entered.
- userCanEdit
- Required. Holds a flag that, if set to true, indicates that the user can edit the status notes of the job. The user can add to as well as delete from the current status notes of the job.
- batchJobs
- Required. Holds a flag that, if set to true, indicates that this job is part of a batch of jobs. If a job is part of a batch, all jobs in that batch will be started, paused, or ended at the same time.
Return Value
Returns true if the user confirms the action; returns false if the user does not
confirm the action or if the call fails for any reason.