TraceMgrPacketReadBegin (FUN)

FUNCTION TraceMgrPacketReadBegin : RTS_IEC_RESULT

Start reading trace packet.

The purpose of this function is to trigger the event EVT_TRACEMGR_PACKET_SAMPLE. In response to the event, any outstanding trace samples will be written by runtime system components and IEC applications that provide trace values for system parameters.

Note

Normally, there is no need to call this function. It should be called before TraceMgrPacketReadFirst and TraceMgrPacketReadFirst2 to make sure all trace values are present before reading. When finished with reading, TraceMgrPacketReadEnd should be called.

InOut:

Scope

Name

Type

Comment

Return

TraceMgrPacketReadBegin

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

  • ERR_PARAMETER if hPacket is not a valid packet handle

  • ERR_NOTINITIALIZED if hPacket is not complete and started

Input

hPacket

RTS_IEC_HANDLE

The trace packet handle