IVisuUserMgmt4.ChangeUser4 (METH) ¶ METHOD ChangeUser4 : BOOL Changes on a user database. The edit type can be: VUM_MODIFY, VUM_ADD, VUM_REMOVE AND VUM_INSERT InOut: Scope Name Type Comment Return ChangeUser4 BOOL Input pClientData POINTER TO VisuElems.VisuStructClientData It’s needed only in case of RTS-based user management dwUserDB DWORD It’s needed only in case of legacy user management pvumUserNew POINTER TO VUM_UserInternal The user data with new data pvumUserOld POINTER TO VUM_UserInternal The user data with old data udiIndex UDINT Index to use for user list eEditType VUM_EditType Activity to do (only for legacy)
IVisuUserMgmt4.GetUsers4 (METH) ¶ METHOD GetUsers4 : DWORD Gets the users InOut: Scope Name Type Comment Return GetUsers4 DWORD Input pClientData POINTER TO VisuElems.VisuStructClientData It’s needed only in case of RTS-based user management dwUserDB DWORD It’s needed only in case of legacy user management 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_UserInternal The user data which should be filled udiArrSize UDINT The size of the given user array
IVisuUserMgmt4.LogoutRts (METH) ¶ METHOD LogoutRts It does a logout in RTS InOut: Scope Name Type Input pClientData POINTER TO VisuElems.VisuStructClientData
IVisuUserMgmtProvider (ITF) ¶ INTERFACE IVisuUserMgmtProvider Methods: SetUserCount SetUserDB SetUsers Structure: SetUserCount (Method) SetUserDB (Method) SetUsers (Method)
VUM_ErrorCodes (GVL) ¶ InOut: Scope Name Type Initial Comment Constant ERR_OK UDINT 16#0 IMPORTANT NOTE: Do not add further errors here, but in the interface library ERR_FAILED UDINT 16#1 The operation failed ERR_PARAMETER UDINT 16#2 Wrong parameter ERR_VUM_FILE_NOT_FOUND UDINT 16#5000 The user management file was not found ERR_VUM_TEMP_FILE_CANNOT_BE_OPENED UDINT 16#5001 The user management temp file cannot be opened ERR_VUM_FILE_READ_FAILED UDINT 16#5002 The user management file cannot be read ERR_VUM_FILE_WRITE_FAILED UDINT 16#5003 The user management file cannot be written ERR_VUM_INVALID_FILE_CONTENT UDINT 16#5004 The user management file has a invalid content ERR_VUM_USERNAME_ALREADY_EXIST UDINT 16#5005 The user name must be unique ERR_VUM_WRONG_PASSWORD UDINT 16#5006 The password is wrong ERR_VUM_UNEQUAL_PASSWORD UDINT 16#5007 The password isn’t equal to the acknowledge password ERR_VUM_NEW_USER_DB_CANNOT_BE_STORED UDINT 16#5008 The new user db file cannot be stored ERR_VUM_ONLY_VISIBLE_USERS_CAN_BE_REMOVED UDINT 16#5009 Only visible users can be removed ERR_VUM_EMPTY_PASSWORD_NOT_ALLOWED UDINT 16#500A An empty password is not allowed ERR_VUM_ANOTHER_CLIENT_EDITS_UM UDINT 16#500B Only one client can edit user management entries ERR_VUM_SYSFILE_ERROR UDINT 16#500C Error during working with SysFile ERR_VUM_SETNEWUSERDB_FAILED UDINT 16#500D Set new user database failed ERR_VUM_PROXY_IS_NOT_IN_IDLE_MODE UDINT 16#500E Proxy is not in idle mode ERR_VUM_DATASERVER_ERROR UDINT 16#500F DataServer ProcessDataServerRequest error ERR_VUM_DATASERVER_ERROR_USERS UDINT 16#5010 The user list cannot be read from the remote system ERR_VUM_MAX_GROUP_LIMIT UDINT 16#5011 The maximum number of possible groups is exceeded ERR_VUM_USER_DOES_NOT_EXIST UDINT 16#5012 The user does not exist ERR_VUM_USER_IS_INACTIVE UDINT 16#5013 The user is inactive ERR_VUM_NO_LOGIN_PROVIDER_AVAILABLE UDINT 16#5014 The login dialog cannot be opened because the maximum number of login dialogs is reached ERR_VUM_NO_CLIENT_MEMORY UDINT 16#5015 No client memory ERR_VUM_NO_USER_LOGGED_IN UDINT 16#5016 No user logged in ERR_VUM_NO_VALID_USERGROUP_SET UDINT 16#5017 No valid user group set ERR_VUM_NO_RIGHT_TO_CHANGE_USERS UDINT 16#5018 No right to change users ERR_VUM_NO_USER_MANAGEMENT UDINT 16#5019 No user management ERR_VUM_USER_NOT_IN_USER_GROUP UDINT 16#501A The user does not belong to the user group ERR_VUM_EXTERNAL_USER_DATABASE_PROVIDER2_NOT_IMPLEMENTED UDINT 16#501B The external user database provider does not implement IExternalUserDatabaseProvider2 ERR_VUM_LOGIN_WRONG_ATTEMPT UDINT 16#501C The password is wrong and the login attempts are limited ERR_VUM_LOGIN_SECONDLAST_WRONG_ATTEMPT UDINT 16#501D The password is wrong and the login attempts are limited. Only one more attempt is left ERR_VUM_LOGIN_LOCKOUT_TEMP UDINT 16#501E This was the last wrong login attempt. User will be locked for defined time ERR_VUM_LOGIN_LOCKOUT_COMPLETE UDINT 16#501F This was the last wrong login attempt. User will be locked completly ERR_VUM_EMPTY_USER_NAME_NOT_ALLOWED UDINT 16#5020 Modifiing an user with an empty user name is not allowed
VUM_Events (GVL) ¶ InOut: Scope Name Type Initial Comment Constant CMPID_CmpVisuServer DWORD 16#57 See declaration of this component raising event in runtime system
VUM_UserAdminAccess (ENUM) ¶ TYPE VUM_UserAdminAccess : InOut: Name Comment None No access FullAdmin Full adminitrator rights RestrictAdmin Restricted administrator rights
IVisuUserMgmt.SetLastError (METH) ¶ METHOD SetLastError : BOOL InOut: Scope Name Type Return SetLastError BOOL Input udiLastError UDINT
IVisuUserMgmt.SetNewUserDB (METH) ¶ METHOD SetNewUserDB : BOOL InOut: Scope Name Type Return SetNewUserDB BOOL Input dwUserDB DWORD bResultOK BOOL
IVisuUserMgmt.SetProvider (METH) ¶ METHOD SetProvider : BOOL InOut: Scope Name Type Return SetProvider BOOL Input itfVisuUserMgmtProvider IVisuUserMgmtProvider
