UserMgrObjectGetNextChild (FUN) ¶ FUNCTION UserMgrObjectGetNextChild : RTS_IEC_HANDLE Iteration interface to get the next child object in the object tree of the specified father object. Must be started with UserMgrObjectGetFirstChild() Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetNextChild RTS_IEC_HANDLE Handle to the next child object or RTS_INVALID_HANDLE if failed Input hFatherObject RTS_IEC_HANDLE Handle to the father object hPrevChild RTS_IEC_HANDLE Handle to the previous child object retrieved by UserMgrObjectGetFirstChild() or subsequent calls of UserMgrObjectGetNextChild() Output Result RTS_IEC_RESULT Error code ERR_OK: Next child object available ERR_PARAMETER: Invalid parameter hFatherObject or hPrevChildObject ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NO_ACCESS_RIGHTS: No access rights in IEC context
UserMgrObjectGetNextGroup (FUN) ¶ FUNCTION UserMgrObjectGetNextGroup : RTS_IEC_HANDLE Iteration interface to get the next group in the user rights management of the specified object. Must be started with UserMgrObjectGetFirstGroup() InOut: Scope Name Type Comment Return UserMgrObjectGetNextGroup RTS_IEC_HANDLE Handle to the next group of the object in the user rights management or RTS_INVALID_HANDLE if failed Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hPrevGroup RTS_IEC_HANDLE Handle to the previous group retrieved via UserMgrObjectGetFirstGroup() or subsequent calls of UserMgrObjectGetNextGroup() Output Result RTS_IEC_RESULT Error code ERR_OK: Next group available ERR_PARAMETER: Invalid handles ERR_NO_OBJECT: No next group available ERR_NO_ACCESS_RIGHTS: User not authorized
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)
TraceMgrPacketStop (FUN) ¶ FUNCTION TraceMgrPacketStop : RTS_IEC_RESULT Stops a trace packet. InOut: Scope Name Type Comment Return TraceMgrPacketStop 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
TraceMgrPacketStore (FUN) ¶ FUNCTION TraceMgrPacketStore : RTS_IEC_RESULT Stores a trace packet to a trace file. Both the trace configuration and the current trace values are stored. InOut: Scope Name Type Comment Return TraceMgrPacketStore RTS_IEC_RESULT 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 writing to files is not supported by the runtime system ERR_NO_OBJECT if opening the file failed ERR_FAILED if creating or writing to the file failed Input hPacket RTS_IEC_HANDLE The trace packet handle Inout Const pszFileName STRING The file path
TraceMgrRecordAdd (FUN) ¶ FUNCTION TraceMgrRecordAdd : RTS_IEC_HANDLE Adds a new record to a trace packet InOut: Scope Name Type Comment Return TraceMgrRecordAdd RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle, if the variable name is not set, or if the variable type is not supported ERR_NOMEMORY if there is not enough free memory to create the record Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pConfiguration TraceRecordConfiguration The record configuration (in) pResult RTS_IEC_RESULT The result code (out)
TraceMgrRecordGetConfig (FUN) ¶ FUNCTION TraceMgrRecordGetConfig : RTS_IEC_RESULT Queries the configuration of a trace record. InOut: Scope Name Type Comment Return TraceMgrRecordGetConfig RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hRecord is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle Inout pConfiguration TraceRecordConfiguration The trace record configuration (out)
TraceMgrRecordGetFirst (FUN) ¶ FUNCTION TraceMgrRecordGetFirst : RTS_IEC_HANDLE Returns the first trace record of a trace packet. This function can be used together with TraceMgrRecordGetNext to iterate through all trace records of a packet. InOut: Scope Name Type Comment Return TraceMgrRecordGetFirst 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 has no trace record Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pResult RTS_IEC_RESULT The result code (out)