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.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. 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.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues This method checks whether the user is in the database and the 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
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. 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. 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
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 10.03.2021, 17:59:23 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuUserMgmt_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuUserMgmt_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released False VisuStructural True LastModificationDateTime date 10.03.2021, 17:59:22 LibraryCategories library-category-list Intern|Visu Author string 3S-Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace VisuUserManagement_Interfaces Description See: Description DocFormat reStructuredText Project VisuUserMgmt_Itfs Title Visu User Mgmt Interfaces Version version 3.5.17.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
