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

TraceMgrPacketReadEnd (FUN) ¶ FUNCTION TraceMgrPacketReadEnd : RTS_IEC_RESULT End reading trace packet. See description of function TraceMgrPacketReadBegin . InOut: Scope Name Type Comment Return TraceMgrPacketReadEnd 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

TraceMgrPacketReadFirst (FUN) ¶ FUNCTION TraceMgrPacketReadFirst : RTS_IEC_HANDLE Reads the contents of the first record. Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note You should call TraceMgrPacketReadBegin before calling this function, to make sure any outstanding trace values are written to the trace buffers. Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadFirst RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NO_OBJECT if the packet does not have a single record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code

TraceMgrPacketReadFirst2 (FUN) ¶ FUNCTION TraceMgrPacketReadFirst2 : RTS_IEC_HANDLE Reads the contents of the first record, starting at a given time stamp. Only entries with a time stamp greater than or equal to ulTimestamp are copied. If the time stamp is zero, the function behaves like TraceMgrPacketReadFirst . Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note You should call TraceMgrPacketReadBegin before calling this function, to make sure any outstanding trace values are written to the trace buffers. Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadFirst2 RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NO_OBJECT if the packet does not have a single record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle ulTimestamp UDINT The time stamp (relative to the trace start time) from where to start copying Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code

TraceMgrPacketReadNext (FUN) ¶ FUNCTION TraceMgrPacketReadNext : RTS_IEC_HANDLE Reads the contents of the next record. Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadNext RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle or if hPrevRecord is not a valid record handle ERR_NO_OBJECT if there is no next record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle hPrevRecord RTS_IEC_HANDLE The trace record handle of the current record Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code

TraceMgrPacketReadNext2 (FUN) ¶ FUNCTION TraceMgrPacketReadNext2 : RTS_IEC_HANDLE Reads the contents of the next record, starting at a given time stamp. Only entries with a time stamp greater than or equal to ulTimestamp are copied. If the time stamp is zero, the function behaves like TraceMgrPacketReadNext . Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadNext2 RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle or if hPrevRecord is not a valid record handle ERR_NO_OBJECT if there is no next record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle hPrevRecord RTS_IEC_HANDLE The trace record handle of the current record ulTimestamp UDINT The time stamp (relative to the trace start time) from where to start copying Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code

TraceMgrPacketResetTrigger (FUN) ¶ FUNCTION TraceMgrPacketResetTrigger : RTS_IEC_RESULT Resets the trigger of a trace packet. The start time and date of of the trigger is reset to 0 and the trigger is set to state enabled (if it is not disabled). InOut: Scope Name Type Comment Return TraceMgrPacketResetTrigger RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketRestart (FUN) ¶ FUNCTION TraceMgrPacketRestart : RTS_IEC_RESULT Restarts a trace packet and resets the start time and the trigger. In contrast to TraceMgrPacketStart, the trace is stopped and the start time is reset to the current time before it is started again. InOut: Scope Name Type Comment Return TraceMgrPacketRestart RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketRestore (FUN) ¶ FUNCTION TraceMgrPacketRestore : RTS_IEC_HANDLE Loads a trace packet from a trace file. Both the trace configuration and the current trace values are restored. InOut: Scope Name Type Comment Return TraceMgrPacketRestore RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid handle, or if pszFileName is not a valid file path ERR_NOMEMORY if the memory is not sufficient for opening the file ERR_NOT_SUPPORTED if reading from files is not supported by the runtime system or if an addressing mode is not supported (e.g. symbolic access) ERR_NO_OBJECT if opening the file failed ERR_FAILED if opening the file failed Inout Const pszFileName STRING The file path (in) Inout pResult RTS_IEC_RESULT The result code (out)

TraceMgrPacketStart (FUN) ¶ FUNCTION TraceMgrPacketStart : RTS_IEC_RESULT Starts a trace packet and resets the trigger. Note if the packet is started for the first time, the start time of the packet is set to the current time. See: TraceMgrPacketGetStartTime . InOut: Scope Name Type Comment Return TraceMgrPacketStart RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle (in)