Batch.EnterSynchronizedSection

Syntax

Batch.EnterSynchronizedSection( sectionName, batchSyncTypeParam, timeoutInSeconds, sequenceContextObj, processMsgs, waitRes, jumpedToExit)

Purpose

Marks the beginning of a synchronized section and defines the type of synchronization for the section.

Parameters

sectionName As String

[In] Specifies a name for the synchronized section.

batchSyncTypeParam As BatchSyncType

[In] Specifies the type of synchronization for the section.

timeoutInSeconds As Double

[In] Specifies a timeout in seconds. Pass a negative number to specify that you do not want a timeout.

sequenceContextObj As Object

[In] Specifies the sequence context of the sequence in which the calling step resides. You must use the run-time copy of the sequence in which the step is currently executing.

Note You must pass a sequence context for this method. Using this method to define Batch synchronization is supported only from code modules.

processMsgs As Boolean

[In] Pass True to process Microsoft Windows messages while waiting. When you call this method from an execution, pass True for this parameter. Otherwise, pass False .

waitRes As WaitResult

[Out] Returns the status of the operation.

jumpedToExit As Boolean

[Out] Returns True when the calling thread jumped to the exit of the section.

See Also

Batch.ExitSynchronizedSection

BatchSyncType

WaitResult