Enum ¶ ERROR (Enum) VisuClientType (Enum) VisuInputType (Enum)
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 13.12.2023, 11:05:45 companyName string 3S-Smart Software Solutions GmbH libraryFile Visu Utils.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Visu Utils.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True IsEndUserLibrary True OnlineHelp True Released True LastModificationDateTime date 13.12.2023, 11:05:39 LibraryCategories library-category-list Intern|Utils AllowVisuLibraryRedirection string True Author CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace VU Description See: Description DocFormat reStructuredText DocLanguages en,de LanguageModelAttribute qualified-access-only Placeholder VisuUtils Project Visu Utils Title Visu Utils Version version 4.5.0.0
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
IExternalUserDatabaseProvider.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 Output wstFullName WSTRING the full name of the user
IExternalUserDatabaseProvider.ChangeUser (METH) ¶ METHOD ChangeUser : VUM_ReturnValues Changes on a user database. The edit type can be: VUM_MODIFY, VUM_ADD, VUM_REMOVE AND VUM_INSERT 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 ChangeUser VUM_ReturnValues Input pvumUser POINTER TO VUM_User The new user data udiIndex UDINT The index of this edit operation eEditType VUM_EditType The type of this edit operation
IExternalUserDatabaseProvider.GetUserCount (METH) ¶ METHOD GetUserCount : UDINT Returns the number of all available users. InOut: Scope Name Type Return GetUserCount UDINT
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
VisuUserMgmt3 Interfaces Library Documentation ¶ Company : System Title : VisuUserMgmt3 Interfaces Version : 4.5.0.0 Categories : Intern|Visu Namespace : VisuUserManagement_Interfaces Author : CODESYS Development GmbH Description [ 1 ] ¶ This library contains the interfaces for the user management functionality for the visualization. Contents: ¶ ExternalUserDatabase Interfaces VUM_Constants (GVL) VUM_EditType (Enum) VUM_ReturnValues (Enum) VUM_User (Struct) VUM_User2 (Struct) VUM_User3 (Struct) VisuUserManagement IVisuUserManagement (Interface) IVisuUserManagement2 (Interface) IVisuUserManagement3 (Interface) IVisuUserManagement4 (Interface) Indices and tables ¶ [ 1 ] Based on VisuUserMgmt3_Itfs.library, last modified 13.12.2023, 11:18:38. LibDoc 4.4.0.0-b.37 The content file VisuUserMgmt3_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 13.12.2023, 11:18:40.
ExternalUserDatabase ¶ Interfaces IExternalUserDatabaseProvider (Interface) ChangePassword ChangeUserPassword (Method) Login CheckLogin (Method) CheckLoginWithGroupID (Method) UserManagement ChangeUser (Method) GetUserCount (Method) GetUsers (Method) IExternalUserDatabaseProvider2 (Interface) UserManagement FindUserByType (Method)
