UserMgrUserSetProperty (FUN) ¶ FUNCTION UserMgrUserSetProperty : RTS_IEC_RESULT Set properties of a user. See category ‘User and group properites’ InOut: Scope Name Type Comment Return UserMgrUserSetProperty RTS_IEC_RESULT Error code ERR_OK: Properties could be set ERR_PARAMETER: Invalid user ERR_FAILED: Invalid combination of property flags (e.g. password change not allowed but password not up to date) ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars Input userProperty DWORD User properties

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:02:41 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpUserMgr Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpUserMgr Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True LastModificationDateTime date 02.03.2023, 11:02:39 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder CmpUserMgr Implementation Project CmpUserMgr Implementation Title CmpUserMgr Implementation Version version 3.5.19.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpUserMgr Interfaces ¶ Library Identification ¶ Name: CmpUserMgr Interfaces Version: newest Company: System Namespace: CmpUserMgr_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr Interfaces, * (System) SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)

UserMgrGroupAddUser (FUN) ¶ FUNCTION UserMgrGroupAddUser : RTS_IEC_RESULT Add a user to a group in the user group database InOut: Scope Name Type Comment Return UserMgrGroupAddUser RTS_IEC_RESULT Error code ERR_OK: User could be added ERR_NOMEMORY: No memory to add user to group ERR_DUPLICATE: pszUserName is already added. 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 pszUserName STRING Name of the user

UserMgrGroupGetFirst (FUN) ¶ FUNCTION UserMgrGroupGetFirst : RTS_IEC_HANDLE Iteration interface to get the first user group InOut: Scope Name Type Comment Return UserMgrGroupGetFirst RTS_IEC_HANDLE Handle to the first user group or RTS_INVALID_HANDLE if failed Input hUser RTS_IEC_HANDLE Handle to authorized user Output Result RTS_IEC_RESULT Error code ERR_OK: First user group available ERR_NO_OBJECT: No user group configured ERR_NO_ACCESS_RIGHTS: User not authorized

UserMgrGroupGetFirstUser (FUN) ¶ FUNCTION UserMgrGroupGetFirstUser : RTS_IEC_RESULT Iteration interface to get the first user of the user group InOut: Scope Name Type Comment Return UserMgrGroupGetFirstUser RTS_IEC_RESULT Error code ERR_OK: First user in the group available ERR_NO_OBJECT: No user configured in the user group 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 UserMgrGroupGetNextUser() pszUsername STRING(59) Buffer to store the name, 59 chars max

UserMgrGroupGetHandle (FUN) ¶ FUNCTION UserMgrGroupGetHandle : RTS_IEC_HANDLE Retrieve the handle from the given group name InOut: Scope Name Type Comment Return UserMgrGroupGetHandle RTS_IEC_HANDLE Correspondig group handle or RTS_INVALID_HANDLE if failed Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszGroupName STRING Name of the group Output Result RTS_IEC_RESULT Error code ERR_OK: Group handle could be retrieved ERR_NO_OBJECT: Group was not found ERR_NO_ACCESS_RIGHTS: User not authorized

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