UserMgrUserGetName (FUN) ¶ FUNCTION UserMgrUserGetName : RTS_IEC_RESULT Get user name from a user handle InOut: Scope Name Type Comment Return UserMgrUserGetName RTS_IEC_RESULT Error code ERR_OK: User name copied ERR_INVALID_HANDLE: hUser not a valid user handle. Input hUser RTS_IEC_HANDLE Handle to authorized user Inout pszUsername STRING(59) Buffer to store the name, 59 chars max
UserMgrUserGetNext (FUN) ¶ FUNCTION UserMgrUserGetNext : RTS_IEC_RESULT Iteration interface to get next user. Must be started with UserMgrUserGetFirst() InOut: Scope Name Type Comment Return UserMgrUserGetNext 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 Inout phIterator RTS_IEC_HANDLE Iteration handle to use with next call to UserMgrUserGetNext() pszUsername STRING(59) Buffer to store the name, 59 chars max Output UserProperty DWORD User properties. See category ‘User and group properites’
UserMgrUserGetProperty (FUN) ¶ FUNCTION UserMgrUserGetProperty : DWORD Get properties of a user InOut: Scope Name Type Comment Return UserMgrUserGetProperty DWORD The users properties. See category ‘User and group properites’ Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars Output Result RTS_IEC_RESULT Error code ERR_OK: Properties could be retrieved ERR_NO_ACCESS_RIGHTS: User not authorized
UserMgrUserRemove (FUN) ¶ FUNCTION UserMgrUserRemove : RTS_IEC_RESULT Remove user from the user database InOut: Scope Name Type Comment Return UserMgrUserRemove RTS_IEC_RESULT Error code ERR_OK: User could be removed ERR_PARAMETER: Invalid parameter. pszUser empty 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
UserMgrUserRemoveInfoFromAllUsers (FUN) ¶ FUNCTION UserMgrUserRemoveInfoFromAllUsers : DWORD Removes a specific cache value from all logged in users. InOut: Scope Name Type Comment Return UserMgrUserRemoveInfoFromAllUsers DWORD ERR_OK: Removing cache value successful ERR_NO_OBJECT: No cache value with this key available ERR_FAILED: Removing cache value failed Input key __XWORD Key of the cache value.
UserMgrUserRemoveInfoFromUser (FUN) ¶ FUNCTION UserMgrUserRemoveInfoFromUser : DWORD Removes a specific cache value from an user. InOut: Scope Name Type Comment Return UserMgrUserRemoveInfoFromUser DWORD ERR_OK: Removing cache value successful ERR_NO_OBJECT: No cache value with this key available ERR_FAILED: Removing cache value failed Input hUser RTS_IEC_HANDLE Handle to authorized user key __XWORD Key of the cache value.
UserMgrUserSetCredentials (FUN) ¶ FUNCTION UserMgrUserSetCredentials : RTS_IEC_RESULT Set or overwrite the credentials of the user InOut: Scope Name Type Comment Return UserMgrUserSetCredentials RTS_IEC_RESULT Error code ERR_OK: Credentials could be set ERR_PARAMETER: Invalid user name or credentials ERR_DUPLICATE: The new and the old credentials are the same 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 pCredentials UserMgrCredentials Credentials, only password is available so far, password (plain text) is limited to 59 chars
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)
