File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:03:35 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpVisuHandler.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpVisuHandler.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 02.03.2023, 11:03:33 LibraryCategories library-category-list System|SysLibs Author string 3S-Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder CmpVisuHandler Project CmpVisuHandler Title CmpVisuHandler Version version 3.5.19.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 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)
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)
CmpUserMgr Library Documentation ¶ Company System Title CmpUserMgr Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library provides access to the user management. The user management in the runtime system is based on ACL (Access Control Lists). Here we have Users and UserGroups and access rights on objects. Every object in the runtime system, that must be protected with access rights, is registered dynamically during startup of the runtime by the corresponding component under the appropriate folder. The objects in the runtime system are organized as a tree with 2 root nodes: - Runtime system object : "Device" |----- "PlcLogic" |----------- "Application" |----- "Logger" |----- "Settings" |----- "UserManagement" - File system objects : "/" |----- "Temp" |----------- "Test.txt" On every object there are assigned all user groups. And for every user group you can specify the appropriate access rights. There are 5 different access rights that can be specified at every group for each object: - USERDB_RIGHT_NONE: Access denied - USERDB_RIGHT_VIEW: Only view rights on the object. Object cannot be modified in any case! - USERDB_RIGHT_MODIFY: Object can be viewed and modified - USERDB_RIGHT_EXECUTE: Object can be executed - USERDB_RIGHT_ADD_REMOVE: It is allowed to add and remove objects or sub objects - USERDB_RIGHT_ALL: All rights allowed on the object Not every access right is retrieved by an object. Which access rights are used are specified by each object and are masked in the user rights editor in the programming system! Indices and tables ¶ 1 Based on CmpUserMgr.library, last modified 20.04.2021, 15:58:15. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:58:15.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:58:15 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpUserMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpUserMgr.clean.json version version 2.0.0.0 ProjectInformation IsContainerLibrary bool True IsEndUserLibrary False Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:58:15 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpUserMgr Title CmpUserMgr Version version 3.5.17.0