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)
UserMgrGroupGetName (FUN) ¶ FUNCTION UserMgrGroupGetName : RTS_IEC_RESULT Get group name InOut: Scope Name Type Comment Return UserMgrGroupGetName RTS_IEC_RESULT Error code ERR_OK: Group name is returned ERR_PARAMETER: Invalid group handle ERR_BUFFERSIZE: The buffer was too small ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hGroup RTS_IEC_HANDLE Handle to the group Inout pszGroup STRING(59) Buffer to store the name, 59 chars max
UserMgrGroupGetNext (FUN) ¶ FUNCTION UserMgrGroupGetNext : RTS_IEC_HANDLE Iteration interface to get next user group. Must be started with UserMgrGroupGetFirst() InOut: Scope Name Type Comment Return UserMgrGroupGetNext RTS_IEC_HANDLE Handle to the next user group or RTS_INVALID_HANDLE if failed Input hUser RTS_IEC_HANDLE Handle to authorized user hPrevGroup RTS_IEC_HANDLE Handle to the previous user group retrieved via UserMgrGroupGetFirst() or subsequent calls of UserMgrGroupGetNext() Output Result RTS_IEC_RESULT Error code ERR_OK: Next user group available ERR_NO_OBJECT: No next user group available ERR_NO_ACCESS_RIGHTS: User not authorized
UserMgrGroupGetNextUser (FUN) ¶ FUNCTION UserMgrGroupGetNextUser : RTS_IEC_RESULT Iteration interface to get next configured user of the user group. Must be started with UserMgrGroupGetFirstUser() InOut: Scope Name Type Comment Return UserMgrGroupGetNextUser RTS_IEC_RESULT Error code ERR_OK: Next user available ERR_NO_OBJECT: No next user available ERR_PARAMETER: Invalid iterator handle ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hGroup RTS_IEC_HANDLE Group handle Inout phIterator RTS_IEC_HANDLE Iteration handle to use with next call to UserMgrGroupGetNextUser() pszUsername STRING(59) Buffer to store the name, 59 chars max
UserMgrGroupRemove (FUN) ¶ FUNCTION UserMgrGroupRemove : RTS_IEC_RESULT Remove a group from user group database InOut: Scope Name Type Comment Return UserMgrGroupRemove RTS_IEC_RESULT Error code ERR_OK: Group was successfully removed ERR_NO_OBJECT: Group name does not exist ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszGroupName STRING Name of the group
UserMgrGroupRemoveUser (FUN) ¶ FUNCTION UserMgrGroupRemoveUser : RTS_IEC_RESULT Remove user from a group in the user group database InOut: Scope Name Type Comment Return UserMgrGroupRemoveUser RTS_IEC_RESULT Error code ERR_OK: User could be removed ERR_NO_OBJECT: Group or user name does not exist ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszGroup STRING Group name pszUser STRING User name
Objecthandling ¶ UserMgrObjectAdd (Function) UserMgrObjectAddGroup (Function) UserMgrObjectClearRights (Function) UserMgrObjectGetFirstChild (Function) UserMgrObjectGetFirstGroup (Function) UserMgrObjectGetGroupRights (Function) UserMgrObjectGetHandle (Function) UserMgrObjectGetName (Function) UserMgrObjectGetNextChild (Function) UserMgrObjectGetNextGroup (Function) UserMgrObjectRemove (Function) UserMgrObjectRemoveGroup (Function) UserMgrObjectSetGroupDeniedRights (Function) UserMgrObjectSetGroupRights (Function) UserMgrObjectSetUsedRights (Function)
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)