IVisuUserManagement (ITF) ¶ INTERFACE IVisuUserManagement Interface to the visu user management which can be used from an IEC application Methods: CheckLogin CheckLoginWithGroupID RegisterExternalUserDatabaseProvider Structure: CheckLogin (Method) CheckLoginWithGroupID (Method) RegisterExternalUserDatabaseProvider (Method)
IVisuUserManagement.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues This method checks whether the user is in the database and the password is correct. 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 CheckLogin VUM_ReturnValues Input wstUserName WSTRING the user name wstPassword WSTRING the password of the user
IVisuUserManagement.CheckLoginWithGroupID (METH) ¶ METHOD CheckLoginWithGroupID : VUM_ReturnValues This method checks whether the user is in the database, the password is correct and the user belongs to the user group. 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 CheckLoginWithGroupID VUM_ReturnValues Input wstUserName WSTRING the user name wstPassword WSTRING the password of the user dwUserGroupID DWORD the user group id to which the user must belong to
IVisuUserManagement.RegisterExternalUserDatabaseProvider (METH) ¶ METHOD RegisterExternalUserDatabaseProvider : VUM_ReturnValues This method registers an external user database provider. Only one external user database provider can be registered. see IExternalUserDatabaseProvider (ITF) 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 Return RegisterExternalUserDatabaseProvider VUM_ReturnValues Input itfExtenalUserDatabaseProvider IExternalUserDatabaseProvider
IVisuUserManagement2 (ITF) ¶ INTERFACE IVisuUserManagement2 EXTENDS IVisuUserManagement , __SYSTEM.IQueryInterface Extension of interface IVisuUserManagement which provides the functionallity to login a user from an IEC application Methods: LoginToUserGroup LoginToUserGroups CheckLogin , inherited from IVisuUserManagement CheckLoginWithGroupID , inherited from IVisuUserManagement RegisterExternalUserDatabaseProvider , inherited from IVisuUserManagement Structure: LoginToUserGroup (Method) LoginToUserGroups (Method)
IVisuUserManagement2.LoginToUserGroup (METH) ¶ METHOD LoginToUserGroup : BOOL With this method a programmatic login for a specific visualization client can be executed for one specific user group. It does NOT check if the credentials are ok. It works with both legacy and runtime-based user management If everything is correct the function returns TRUE. InOut: Scope Name Type Comment Return LoginToUserGroup BOOL Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData dwGroupId DWORD The user group id wstUserName WSTRING(79) The user name which is afterwards content in VisuElems.CurrentUserName wstFullName WSTRING(79) The full user name which is afterwards content in VisuElems.CurrentFullUserName
IVisuUserManagement2.LoginToUserGroups (METH) ¶ METHOD LoginToUserGroups : BOOL With this method a programmatic login for a specific visualization client can be executed for a list of user groups. It does NOT check if the credentials are ok. It works with both legacy and runtime-based user management If everything is correct the function returns TRUE. InOut: Scope Name Type Comment Return LoginToUserGroups BOOL Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData padwUserGroupIds POINTER TO ARRAY [0..0] OF DWORD A pointer to an array of user group ids dwUserGroupCount DWORD The number of user groups ids in the array padwUserGroupIds wstUserName WSTRING(79) The user name which is afterwards content in VisuElems.CurrentUserName wstFullName WSTRING(79) The full user name which is afterwards content in VisuElems.CurrentFullUserName
IVisuUserManagement3 (ITF) ¶ INTERFACE IVisuUserManagement3 EXTENDS IVisuUserManagement2 Extension of interface IVisuUserManagement2 Methods: ChangePassword Login Logout UserCount Users CheckLogin , inherited from IVisuUserManagement CheckLoginWithGroupID , inherited from IVisuUserManagement LoginToUserGroup , inherited from IVisuUserManagement2 LoginToUserGroups , inherited from IVisuUserManagement2 RegisterExternalUserDatabaseProvider , inherited from IVisuUserManagement Structure: ChangePassword (Method) Login (Method) Logout (Method) UserCount (Method) Users (Method)
IVisuUserManagement3.ChangePassword (METH) ¶ METHOD ChangePassword : VUM_ReturnValues It changes the user password 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 ChangePassword VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData wstUserName WSTRING(79) The user name wstNewPassword WSTRING(79) The new password wstOldPassword WSTRING(79) The old password
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 23.05.2024, 09:58:32 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuUserMgmt.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuUserMgmt.clean.json version version 2.0.0.0 ProjectInformation Released bool True VisuStructural True LastModificationDateTime date 23.05.2024, 09:58:23 LibraryCategories library-category-list Intern|Visu Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace VisuUserManagement Description See: Description LanguageModelAttribute qualified-access-only Placeholder VisuUserManagement Project VisuUserMgmt ServerBuildException ok Title VisuUserMgmt Version version 4.6.0.0
