UserMgrObjectClearRights (FUN) ¶ FUNCTION UserMgrObjectClearRights : RTS_IEC_RESULT This function clears all granted and denied rights for all groups on that object. InOut: Scope Name Type Comment Return UserMgrObjectClearRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be cleared 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

UserMgrObjectGetFirstChild (FUN) ¶ FUNCTION UserMgrObjectGetFirstChild : RTS_IEC_HANDLE Iteration interface to get the first child object in the object tree of the specified father object Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetFirstChild RTS_IEC_HANDLE Handle to the child object or RTS_INVALID_HANDLE if failed Input hFatherObject RTS_IEC_HANDLE Handle to the father object Output Result RTS_IEC_RESULT Error code ERR_OK: First child object available ERR_PARAMETER: Invalid parameter hFatherObject ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_NO_ACCESS_RIGHTS: No access rights in IEC context

UserMgrObjectGetFirstGroup (FUN) ¶ FUNCTION UserMgrObjectGetFirstGroup : RTS_IEC_HANDLE Iteration interface to get the first group in the user rights management of the specified object InOut: Scope Name Type Comment Return UserMgrObjectGetFirstGroup RTS_IEC_HANDLE Handle to the first 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 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

UserMgrObjectGetGroupRights (FUN) ¶ FUNCTION UserMgrObjectGetGroupRights : RTS_IEC_RESULT Get the rights and the denied rights of a group on a specified object InOut: Scope Name Type Comment Return UserMgrObjectGetGroupRights RTS_IEC_RESULT Error code ERR_OK: Access rights could be retrieved 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 which access rights are requested Output ulRights DWORD Rights of the group. See category “User rights” for details ulDeniedRights DWORD Denied rights of the group. See category “User rights” for details

UserMgrObjectGetHandle (FUN) ¶ FUNCTION UserMgrObjectGetHandle : RTS_IEC_HANDLE Retrieve the handle from the given object name Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetHandle RTS_IEC_HANDLE Corresponding object handle or RTS_INVALID_HANDLE if failed Inout Const pszObjectName STRING Name of the object Output Result RTS_IEC_RESULT Error code ERR_OK: Object handle could be retrieved ERR_NO_OBJECT: Object was not found ERR_NO_ACCESS_RIGHTS: No access rights in IEC context

UserMgrObjectGetName (FUN) ¶ FUNCTION UserMgrObjectGetName : RTS_IEC_RESULT Get object name Limited to the application subtree. InOut: Scope Name Type Comment Return UserMgrObjectGetName RTS_IEC_RESULT Error code ERR_OK: Object name is returned ERR_PARAMETER: Invalid object handle or pszObject = 0 and piMaxLen = 0 ERR_BUFFERSIZE: The buffer was too small ERR_NO_ACCESS_RIGHTS: No access rights in IEC context Input hObject RTS_IEC_HANDLE Handle to the object pszObject POINTER TO STRING Pointer to buffer to store the name piMaxLen POINTER TO UDINT Pointer to length of buffer in pszObject. If pszObject is 0, only the length of the object name is returned in piMaxLen

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

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.

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)