TraceAddress (UNION) ¶ TYPE TraceAddress : UNION Address of a trace variable InOut: Name Type Comment pbyAddress POINTER TO BYTE Pointer to the trace variable Area AddressArea Area/Offset of an IEC variable systemParameter SystemParameter Parameter of a system variable (e.g. device parameter) propertyLocation PropertyLocation Only used for property monitoring monitoringService MonitoringService Only used by monitoring service symVarAccess SymVarAccess Use for symbolic variable tracing monitoring2ByteCode Monitoring2ByteCode Reserved

TracePacketConfiguration (STRUCT) ¶ TYPE TracePacketConfiguration : STRUCT Configuration of a trace packet InOut: Name Type Comment pszName POINTER TO STRING The name of the trace packet pszApplicationName POINTER TO STRING The name of the application (optional) pszIecTaskName POINTER TO STRING IEC-task name in which the samples are recorded (optional) pszComment POINTER TO STRING A comment for the packet (optional) pttTrigger POINTER TO TraceTrigger Pointer to a trigger description (optional) ptvCondition POINTER TO TraceVariable A pointer to the description of a boolean variable. If given, samples are recorded only if the variable has value true. (optional, must be present if TRACE_PACKET_FLAGS_CONDITION is set in ulFlags) ulEveryNCycles UDINT Record samples every ulEveryNCycles cycles. Must be > 0. (Default: 1) ulBufferEntries UDINT The number of samples that the trace buffer can hold. ulFlags UDINT Trace packet flags. See TRACE_PACKET_FLAGS .

TraceRecordConfiguration (STRUCT) ¶ TYPE TraceRecordConfiguration : STRUCT Trace record configuration The colors (ulGraphColor, ulMinWarningColor, ulMaxWarningColor) and are encoded in UDINTs in the ARGB format: the most significand byte is the alpha value, the next byte the red value, followed by green and blue. Each color component takes a value between 0 and FF. So 0xFF000000 is white, 0xFFFFFFFF is black, 0xFFFF0000 is red, 0xFF00FF00 is green, and 0xFF0000FF is blue. InOut: Name Type Initial Comment pszVariable POINTER TO STRING Name of the variable tvaAddress TraceVariableAddress Address definition of the variable tcClass TypeClass3 Type class of the variable. See enum IBase.TypeClass for the possible values. ulSize UDINT Size in bytes of a single sample ulGraphColor UDINT 16#FF0000FF Color in which the trace curve for the variable should be displayed ulGraphType UDINT 1 Graph type: 1: line (with points) 2: cross 4: step (with points) 5: point 8: line (without points) 9: step (without points) 10: line (with crosses) 11: steps (with crosses)) ulMinWarningColor UDINT Color to use if a sample is <= fCriticalLowerLimit ulMaxWarningColor UDINT Color to use if a sample is >= fCriticalUpperLimit fCriticalLowerLimit REAL The lower limit fCriticalUpperLimit REAL The upper limit bActivateMinWarning BOOL If set, the trace will be displayed in the color ulMinWarningColor as soon as a sample is <= fCriticalLowerLimit bActivateMaxWarning BOOL If set, the trace will be displayed in the color ulMaxWarningColor as soon as a sample is >= fCriticalUpperLimit byYAxis BYTE Not used

TraceRecordEntry (STRUCT) ¶ TYPE TraceRecordEntry : STRUCT A single entry recorded for a trace variable consisting of a relative time stamp and a (variable-size) data part. The size of the data depends on the type class of the trace variable. InOut: Name Type Comment ulTimeRelative UDINT The relative time stamp (since the trace was first started, see TraceState.tStartTime) in the resolution configured for the trace packet Data BYTE A (variable size) data portion for the sample value

TraceState (STRUCT) ¶ TYPE TraceState : STRUCT The state of a trace packet InOut: Name Type Comment ulState UDINT The state. See TRACE_PACKET_STATE ulFillLevel UDINT The number of recorded samples tStartTime SYSTIME The time of the first start of the trace, all time stamps are relative to this value. tsTriggerState TriggerState The state of the trigger.

TraceTrigger (STRUCT) ¶ TYPE TraceTrigger : STRUCT Configuration of the trace trigger InOut: Name Type Comment tvVariable TraceVariable Specification of the trigger variable ttvLevel TriggerValue Holds the trigger level for analog (i.e. non-boolean) triggers ulFlags UDINT Trigger flags. See TRACE_TRIGGER_FLAGS . byEdge BYTE Trigger edge. See TRACE_TRIGGER_EDGE . byPosition BYTE Number of samples to record after the trigger has fired in percent (0..100) of the buffer size. Deprecated, use ulUpdatesAfterTrigger instead. wAlignmentDummy WORD Alignment bytes ulUpdatesAfterTrigger UDINT Number of samples to record after the trigger has fired. Note: TRACE_TRIGGER_FLAGS_UPDATESAFTERTRIGGER must be set in ulFlags, if this entry is used instead of byPosition.

CmpUserMgr Implementation Library Documentation ¶ Company System Title CmpUserMgr Implementation Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpUserMgr Implementation Description 1 ¶ This library contains the implementation used to access the user management of the runtime system as external functions to the CmpUserMgr component. Contents: ¶ CmpUserMgr Functions Indices and tables ¶ 1 Based on CmpUserMgr Implementation.library, last modified 02.03.2023, 11:02:39. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:02:41.

Functions ¶ Authentication UserMgrChangeMyPassword (Function) UserMgrGetSessionUser (Function) UserMgrIsActive (Function) UserMgrLogin (Function) UserMgrLogout (Function) UserMgrRelogin (Function) Authorization UserMgrGetUserAccessRights (Function) UserMgrHasUserAccessRights (Function) Grouphandling UserMgrGroupAdd (Function) UserMgrGroupAddUser (Function) UserMgrGroupGetFirst (Function) UserMgrGroupGetFirstUser (Function) UserMgrGroupGetHandle (Function) UserMgrGroupGetName (Function) UserMgrGroupGetNext (Function) UserMgrGroupGetNextUser (Function) UserMgrGroupRemove (Function) UserMgrGroupRemoveUser (Function) 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) Userhandling UserMgrUserAdd (Function) UserMgrUserAddInfoToUser (Function) UserMgrUserGetFirst (Function) UserMgrUserGetInfoOfUser (Function) UserMgrUserGetName (Function) UserMgrUserGetNext (Function) UserMgrUserGetProperty (Function) UserMgrUserRemove (Function) UserMgrUserRemoveInfoFromAllUsers (Function) UserMgrUserRemoveInfoFromUser (Function) UserMgrUserSetCredentials (Function) UserMgrUserSetProperty (Function)

CmpUserMgr ¶ Functions Authentication UserMgrChangeMyPassword (Function) UserMgrGetSessionUser (Function) UserMgrIsActive (Function) UserMgrLogin (Function) UserMgrLogout (Function) UserMgrRelogin (Function) Authorization UserMgrGetUserAccessRights (Function) UserMgrHasUserAccessRights (Function) Grouphandling UserMgrGroupAdd (Function) UserMgrGroupAddUser (Function) UserMgrGroupGetFirst (Function) UserMgrGroupGetFirstUser (Function) UserMgrGroupGetHandle (Function) UserMgrGroupGetName (Function) UserMgrGroupGetNext (Function) UserMgrGroupGetNextUser (Function) UserMgrGroupRemove (Function) UserMgrGroupRemoveUser (Function) 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) Userhandling UserMgrUserAdd (Function) UserMgrUserAddInfoToUser (Function) UserMgrUserGetFirst (Function) UserMgrUserGetInfoOfUser (Function) UserMgrUserGetName (Function) UserMgrUserGetNext (Function) UserMgrUserGetProperty (Function) UserMgrUserRemove (Function) UserMgrUserRemoveInfoFromAllUsers (Function) UserMgrUserRemoveInfoFromUser (Function) UserMgrUserSetCredentials (Function) UserMgrUserSetProperty (Function)

Authentication ¶ UserMgrChangeMyPassword (Function) UserMgrGetSessionUser (Function) UserMgrIsActive (Function) UserMgrLogin (Function) UserMgrLogout (Function) UserMgrRelogin (Function)