TraceMgrPacketCheckTrigger (FUN) ¶ FUNCTION TraceMgrPacketCheckTrigger : RTS_IEC_RESULT Checks if the trigger fires this cycle and sets the trigger state accordingly. If the trigger is already reached, ERR_OK is returned. Note: this function is called cyclically by CmpTraceMgr and should normally not be called from an application. Use TraceMgrPacketGetState instead to query the current trigger state. InOut: Scope Name Type Comment Return TraceMgrPacketCheckTrigger RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid trace packet ERR_NOTINITIALIZED if no trigger is defined or if the trigger is disabled ERR_FAILED if the check fails Input hPacket RTS_IEC_HANDLE The trace packet handle
TraceMgrPacketClose (FUN) ¶ FUNCTION TraceMgrPacketClose : RTS_IEC_RESULT Closes a handle opened by TraceMgrPacketOpen. InOut: Scope Name Type Comment Return TraceMgrPacketClose 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
TraceMgrPacketComplete (FUN) ¶ FUNCTION TraceMgrPacketComplete : RTS_IEC_RESULT Completes a trace packet and finishes the configuration. This function must be called after all records have been added to the packet. InOut: Scope Name Type Comment Return TraceMgrPacketComplete 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
TraceMgrPacketCreate (FUN) ¶ FUNCTION TraceMgrPacketCreate : RTS_IEC_HANDLE Creates a new trace packet. The returned handle must be deleted with TraceMgrPacketDelete when the packet is no longer needed. InOut: Scope Name Type Comment Return TraceMgrPacketCreate RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if pConfiguration.pszName is 0 ERR_DUPLICATE if a packet with the given name already exists ERR_NOMEMORY if the available memory is not sufficient to create the packet Inout pConfiguration TracePacketConfiguration The trace packet configuration (in) pResult RTS_IEC_RESULT The result code (out)
TraceMgrPacketDelete (FUN) ¶ FUNCTION TraceMgrPacketDelete : RTS_IEC_RESULT Deletes an existing handle. The handle must have been created with TraceMgrPacketCreate. InOut: Scope Name Type Comment Return TraceMgrPacketDelete 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
UserMgrObjectRemoveGroup (FUN) ¶ FUNCTION UserMgrObjectRemoveGroup : RTS_IEC_RESULT Remove a group from the specified object InOut: Scope Name Type Comment Return UserMgrObjectRemoveGroup RTS_IEC_RESULT Error code ERR_OK: Group could be removed ERR_PARAMETER: Invalid handles ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hGroup RTS_IEC_HANDLE Handle to the group that should be removed
UserMgrObjectRemove (FUN) ¶ FUNCTION UserMgrObjectRemove : RTS_IEC_RESULT Removes an object from the user management and all its children Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectRemove RTS_IEC_RESULT Error code ERR_OK: Object could be removed ERR_PARAMETER: Invalid object handle ERR_NO_ACCESS_RIGHTS: No access rights in IEC context Input hObject RTS_IEC_HANDLE Handle to object
UserMgrObjectSetGroupDeniedRights (FUN) ¶ FUNCTION UserMgrObjectSetGroupDeniedRights : RTS_IEC_RESULT Set the denied access rights for the group at the specified object InOut: Scope Name Type Comment Return UserMgrObjectSetGroupDeniedRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be set ERR_PARAMETER: Invalid handles ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hGroup RTS_IEC_HANDLE Handle to the group ulDeniedRights DWORD Denied rights of the group. See category “User rights” for details
UserMgrObjectSetGroupRights (FUN) ¶ FUNCTION UserMgrObjectSetGroupRights : RTS_IEC_RESULT Set the access rights for the group at the specified object InOut: Scope Name Type Comment Return UserMgrObjectSetGroupRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be set ERR_PARAMETER: Invalid handles ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user hObject RTS_IEC_HANDLE Handle to the object hGroup RTS_IEC_HANDLE Handle to the group ulRights DWORD Rights of the group. See category “User rights” for details
UserMgrObjectSetUsedRights (FUN) ¶ FUNCTION UserMgrObjectSetUsedRights : RTS_IEC_RESULT Sets the used access rights for the object specified by handle. The rights are additionally stored in an internal list. In case USERDB_RIGHT_NONE is passed for ulUsedRights the previously stored rights are retrieved for this object. Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectSetUsedRights RTS_IEC_RESULT Error code ERR_OK: Rights are successfully set ERR_PARAMETER: Invalid object handle ERR_NO_OBJECT: Object was not found for rights retrieval ERR_NO_ACCESS_RIGHTS: No access rights in IEC context Input hObject RTS_IEC_HANDLE Handle to the object ulUsedRights DWORD Used access rights or USERDB_RIGHT_NONE for retrieval