Syntax

SyncManager.LogAction( synchronizationMechanism, sequenceContextObj, threadId, threadDisplayName, name, syncState, operation, timeout, postMessage, reserved)

Return Value

Object

Purpose

When the SyncManager.LoggingEnabled property is True , this method posts or returns an OutputMessage with a category of Resource Usage that records the specified action. When the SyncManager.LoggingEnabled property is False , this method does nothing and returns NULL .

Parameters

synchronizationMechanism As String

[In] Specifies the synchronization mechanism that generated the action to log. When the mechanism is a TestStand synchronization mechanism, pass the appropriate SynchronizationMechanism constant.

sequenceContextObj As Object

[In] Specifies the SequenceContext object that identifies the step that performs the resource action to log. This parameter might be NULL when the synchronization state is SyncState_Completed .

threadId As String

[In] Specifies the TestStand thread ID of the thread that performs the resource action to log. This parameter might be an empty string when the synchronization state is SyncState_Completed .

threadDisplayName As String

[In] Specifies the display name of the TestStand thread that performs the resource action to log. This parameter might be an empty string when the synchronization state is SyncState_Completed .

name As String

[In] Specifies the name of the resource to which the action applies.

syncState As SyncStates

[In] Specifies the type of synchronization state to log.

operation As String

[In] Specifies the synchronization operation that generated the action to log.

timeout As Double

[In] When the synchronization state is SyncState_Blocked , pass the timeout period for the wait or pass -1 when no timeout exists. For other synchronization state types, pass 0 .

postMessage As Boolean

[In] Pass True to force this method to post the OutputMessage it creates before it returns. Pass False when you want to add subproperties to the OutputMessage before posting it. Posting the OutputMessage after you add subproperties ensures that the additional properties are added before the OutputMessage is received.

reserved As IUnknown

[In] Pass NULL to this reserved parameter.

See Also

OutputMessage

SequenceContext

SynchronizationMechanism

SyncManager.LoggingEnabled

SyncStates

Use Auto Scheduled Resource steps