TraceMgrPacketCheckTrigger (FUN)

FUNCTION TraceMgrPacketCheckTrigger : RTS_IEC_RESULT

Checks if the trigger fires this cycle and sets the trigger state accordingly.

If the trigger is already reached, ERR_OK is returned.

Note: this function is called cyclically by CmpTraceMgr and should normally not be called from an application. Use TraceMgrPacketGetState instead to query the current trigger state.

InOut:

Scope

Name

Type

Comment

Return

TraceMgrPacketCheckTrigger

RTS_IEC_RESULT
Returns the runtime system error code (see CmpErrors.library):

  • ERR_PARAMETER if hPacket is not a valid trace packet

  • ERR_NOTINITIALIZED if no trigger is defined or if the trigger is disabled

  • ERR_FAILED if the check fails

Input

hPacket

RTS_IEC_HANDLE

The trace packet handle