TraceMgrPacketEnableTrigger (FUN) ¶ FUNCTION TraceMgrPacketEnableTrigger : RTS_IEC_RESULT Enables the trigger of a trace packet. Note This function should be called if the trigger is currently disabled. If the trigger has already fired, call TraceMgrPacketResetTrigger to reset the trigger, instead. InOut: Scope Name Type Comment Return TraceMgrPacketEnableTrigger 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
TraceMgrPacketGetAbsoluteStartTime (FUN) ¶ FUNCTION TraceMgrPacketGetAbsoluteStartTime : RTS_IEC_RESULT Returns the absolute start time of a trace packet or 0 if trace packet has not been started yet. Note The start time is the time when the packet was started for the first time. InOut: Scope Name Type Comment Return TraceMgrPacketGetAbsoluteStartTime RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pStartTime SYSTIME The start time (out)
TraceMgrPacketGetChangeTimestamp (FUN) ¶ FUNCTION TraceMgrPacketGetChangeTimestamp : RTS_IEC_RESULT Returns the timestamp of a trace packet’s last modification. InOut: Scope Name Type Comment Return TraceMgrPacketGetChangeTimestamp 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 Inout pdwTimestamp DWORD The modification timestamp (out)
TraceMgrPacketGetConfig (FUN) ¶ FUNCTION TraceMgrPacketGetConfig : RTS_IEC_RESULT Queries the configuration of a trace packet. InOut: Scope Name Type Comment Return TraceMgrPacketGetConfig RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pConfiguration TracePacketConfiguration The packet configuration (out)
TraceMgrPacketGetFirst (FUN) ¶ FUNCTION TraceMgrPacketGetFirst : RTS_IEC_HANDLE Returns the first trace packet. This function can be used together with TraceMgrPacketGetNext to iterate through all trace packets. InOut: Scope Name Type Comment Return TraceMgrPacketGetFirst RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_NO_OBJECT if there is no trace packet Inout pResult RTS_IEC_RESULT The result code (out)
TraceMgrPacketGetNext (FUN) ¶ FUNCTION TraceMgrPacketGetNext : RTS_IEC_HANDLE Returns the next trace packet. This function can be used together with TraceMgrPacketGetFirst to iterate through all trace packets. InOut: Scope Name Type Comment Return TraceMgrPacketGetNext RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPrevPacket is not a valid handle ERR_NO_OBJECT if hPrevPacket is the last trace packet Input hPrevPacket RTS_IEC_HANDLE The packet handle of the current trace packet Inout pResult RTS_IEC_RESULT The result code
TraceMgrPacketGetStartTime (FUN) ¶ FUNCTION TraceMgrPacketGetStartTime : RTS_IEC_RESULT Returns the start time of a trace packet or 0 if trace packet has not been started yet. Note the start time is the time when the packet was started for the first time. InOut: Scope Name Type Comment Return TraceMgrPacketGetStartTime RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pStartTime SYSTIME The start time (out)
TraceMgrPacketGetState (FUN) ¶ FUNCTION TraceMgrPacketGetState : RTS_IEC_RESULT Returns the state of a trace packet. InOut: Scope Name Type Comment Return TraceMgrPacketGetState 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 Inout pState TraceState The packet state (out)
TraceMgrPacketOpen (FUN) ¶ FUNCTION TraceMgrPacketOpen : RTS_IEC_HANDLE Opens a trace packet specified by name. Note Comparison of packet names is case-insensitive. InOut: Scope Name Type Comment Return TraceMgrPacketOpen RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_NO_OBJECT if no packet with the given name is found. Inout Const pszName STRING The name of the trace packet to open (in) Inout pResult RTS_IEC_RESULT The result code (out)
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