IExternalUserDatabaseProvider.GetUsers (METH) ¶ METHOD GetUsers : VUM_ReturnValues Returns the users in a specified range 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 GetUsers VUM_ReturnValues Input 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_User The user data which should be filled udiArrSize UDINT The size of the given user array

IExternalUserDatabaseProvider2.FindUserByType (METH) ¶ METHOD FindUserByType : VUM_ReturnValues Returns the user with the specified user name 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 FindUserByType VUM_ReturnValues Input vumUserIn VUM_User The user to search for eEditType VUM_EditType The user edit type VUM_FIND_USER_BY_NAME OR VUM_FIND_NEXT_USER_WHICH_BELONGS_TO_ONE_OF_THE_GROUPS Output vumUser VUM_User The found user data udiIndex UDINT The index of the user in the user list

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

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