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)

UserMgrChangeMyPassword (FUN) ¶ FUNCTION UserMgrChangeMyPassword : RTS_IEC_RESULT Changes the users password InOut: Scope Name Type Comment Return UserMgrChangeMyPassword RTS_IEC_RESULT Error code ERR_OK: Password changed successfully ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_OPERATION_DENIED: Password change is either not supported or not allowed ERR_USER_MISMATCH: User name does not match ERR_INVALID_HANDLE: hUser is invalid or unknown Input hUser RTS_IEC_HANDLE Handle to the user pszUser REFERENCE TO STRING Name of the user, limited to 59 chars pszOldPassword REFERENCE TO STRING Old password (plain text), limited to 59 chars pszNewPassword REFERENCE TO STRING New password (plain text), limited to 59 chars

UserMgrGetSessionUser (FUN) ¶ FUNCTION UserMgrGetSessionUser : RTS_IEC_HANDLE Retrieves the user handle assigned to a CODESYS online session. InOut: Scope Name Type Comment Return UserMgrGetSessionUser RTS_IEC_HANDLE Handle of the user or RTS_INVALID_HANDLE if not available. Input sessionId UDINT Session id of which the user handle should be read. pResult POINTER TO RTS_IEC_RESULT Pointer to error code. One of: ERR_OK: User is available ERR_NOTINITIALIZED: The session management is not initialized ERR_NO_OBJECT: The session is not available

UserMgrIsActive (FUN) ¶ FUNCTION UserMgrIsActive : BOOL Checks if the user management is active. InOut: Scope Name Type Comment Return UserMgrIsActive BOOL TRUE: The user management is activated or enforced. FALSE: The user management is not activated.

UserMgrLogin (FUN) ¶ FUNCTION UserMgrLogin : RTS_IEC_HANDLE Logs user in to the runtime system requiring an active user management. InOut: Scope Name Type Comment Return UserMgrLogin RTS_IEC_HANDLE Handle to the user or RTS_INVALID_HANDLE if not available Input pszUser REFERENCE TO STRING Name of the user, limited to 59 chars pszPassword REFERENCE TO STRING Password (plain text), limited to 59 chars pResult POINTER TO RTS_IEC_RESULT Pointer to error code ERR_OK: User/password combination is valid ERR_ACTIVATE_USERMGMT: The login was successful. But the user management is enforced and not active. Activate the user management. ERR_CHANGE_PASSWORD: The login was successful. But the user must change his password. ERR_NO_USERMGMT: Login was not successful. The user management is not activated. Use empty user and password to login. ERR_NO_ACCESS_RIGHTS: The login was not successful, because of another reason.