IVisuUserManagement3.Login (METH) ¶ METHOD Login : VUM_ReturnValues It executes the login It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. In the case of logging in a user what needs to change the password at the first login, the error returned error will be VUM_ReturnValues.ERR_CHANGE_PASSWORD The caller of this method is responsible for handling the error code regarding changing of password, no automatism will be triggered to force a password change see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return Login VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData wstUserName WSTRING(79) The user name wstPassword WSTRING(79) The password of the user Output wstFullNameIfAvailable WSTRING The full name of the user, it it’s available dwUserGroupID DWORD The group id where the user belongs to adwUserGroupIDs ARRAY [0..VUM_Constants.VISU_VUM_MAX_GROUPS_PER_USER] OF DWORD Array of user group ids. In the first entry there’s the user group id, same of dwUserGroupID dwUserGroupCount DWORD Number of additional user groups bDeactivated BOOL Is the user deactivated
IVisuUserManagement3.Logout (METH) ¶ METHOD Logout : VUM_ReturnValues It executes the logout It works with both legacy and runtime-based user managements If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return Logout VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData
IVisuUserManagement3.UserCount (METH) ¶ METHOD UserCount : UDINT Returns the number of all available users. It works with both legacy and runtime-based user management InOut: Scope Name Type Comment Return UserCount UDINT Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData Output result VUM_ReturnValues
IVisuUserManagement3.Users (METH) ¶ METHOD Users : VUM_ReturnValues Returns the users in a specified range It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return Users VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData udiStartIndex UDINT The start index in a list of users udiEndIndex UDINT The end index in a list of users pArr POINTER TO ARRAY [0..0] OF VUM_User2 The user data which should be filled udiArrSize UDINT The size of the given user array
IVisuUserManagement4 (ITF) ¶ INTERFACE IVisuUserManagement4 EXTENDS IVisuUserManagement3 Extension of interface IVisuUserManagement3 with functionality to change userdata (add + insert / remove / change) Methods: EditUser ChangePassword , inherited from IVisuUserManagement3 CheckLogin , inherited from IVisuUserManagement CheckLoginWithGroupID , inherited from IVisuUserManagement Login , inherited from IVisuUserManagement3 LoginToUserGroup , inherited from IVisuUserManagement2 LoginToUserGroups , inherited from IVisuUserManagement2 Logout , inherited from IVisuUserManagement3 RegisterExternalUserDatabaseProvider , inherited from IVisuUserManagement UserCount , inherited from IVisuUserManagement3 Users , inherited from IVisuUserManagement3 Structure: EditUser (Method)
IVisuUserManagement4.EditUser (METH) ¶ METHOD EditUser : VUM_ReturnValues It edits the user data. It works with both legacy and runtime-based user management Only users of group ADMIN can edit other user. Following actions (eEditType) are possible: VUM_MODIFY, VUM_REMOVE, VUM_ADD and VUM_INSERT. (VUM_ADD and VUM_INSERT do the same for runtime-based usermanagement.) The changes on the user data are done immediatly. When using this method within a dialog, e.g. similar to the usermanagement dialog ‘Change configuration’ provided by CODESYS, no cancel is possible. If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return EditUser VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData pvumUserNew POINTER TO VUM_User3 The user data with new data. Needed for VUM_MODIFY, VUM_REMOVE, VUM_ADD and VUM_INSERT. pvumUserOld POINTER TO VUM_User3 The user data with old data, only needed for VUM_MODIFY. udiIndex UDINT Only for legacy Index to use for user list (for VUM_INSERT, VUM_MODIFY and for VUM_REMOVE) eEditType VUM_EditType Activity to do
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 13.12.2023, 11:18:40 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuUserMgmt3_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuUserMgmt3_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True VisuStructural True LastModificationDateTime date 13.12.2023, 11:18:38 LibraryCategories library-category-list Intern|Visu Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace VisuUserManagement_Interfaces Description See: Description DocFormat reStructuredText Project VisuUserMgmt3_Itfs Title VisuUserMgmt3 Interfaces Version version 4.5.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) Data Server Interfaces ¶ Library Identification ¶ Name: Data Server Interfaces Version: newest Company: System Namespace: Dataserver_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Data Server Interfaces, * (System)
IExternalUserDatabaseProvider.ChangeUserPassword (METH) ¶ METHOD ChangeUserPassword : VUM_ReturnValues Changes the password of a given user. If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return ChangeUserPassword VUM_ReturnValues Input wstUserName WSTRING the user name wstNewPassword WSTRING the new password of the user wstOldPassword WSTRING the old password of the user
IExternalUserDatabaseProvider.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues Checks whether the user name and password is correct. If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return CheckLogin VUM_ReturnValues Input wstUserName WSTRING the user name wstPassword WSTRING the password of the user Output wstFullName WSTRING the full name of the user dwUserGroupID DWORD the group id where the user belongs to
