VUM_Constants (GVL) ¶ InOut: Scope Name Type Initial Comment Constant VISU_VUM_MAX_GROUPS_PER_USER INT 10 The maximum number of groups a visu user can belong to

VUM_EditType (ENUM) ¶ TYPE VUM_EditType : InOut: Name Initial VUM_NONE 0 VUM_ADD 1 VUM_INSERT 2 VUM_MODIFY 3 VUM_REMOVE 4 VUM_CHECKPASSWORD 5 VUM_CHANGEPASSWORD 6 VUM_CHECKPASSWORD_AND_GROUPID 7

VUM_ReturnValues (ENUM) ¶ TYPE VUM_ReturnValues : InOut: Name Initial Comment ERR_OK 16#0 Standard return values ERR_FAILED 16#1 The operation failed ERR_PARAMETER 16#2 Wrong parameter ERR_VUM_FILE_NOT_FOUND 16#5000 Range for VisuUserMan Errors 16#5000 until 16#50FF ERR_VUM_TEMP_FILE_CANNOT_BE_OPENED 16#5001 The user management temp file cannot be opened ERR_VUM_FILE_READ_FAILED 16#5002 The user management file cannot be read ERR_VUM_FILE_WRITE_FAILED 16#5003 The user management file cannot be written ERR_VUM_INVALID_FILE_CONTENT 16#5004 The user management file has a invalid content ERR_VUM_USERNAME_ALREADY_EXIST 16#5005 The user name must be unique ERR_VUM_WRONG_PASSWORD 16#5006 The password is wrong ERR_VUM_UNEQUAL_PASSWORD 16#5007 The password isn’t equal to the acknowledge password ERR_VUM_NEW_USER_DB_CANNOT_BE_STORED 16#5008 The new user db file cannot be stored ERR_VUM_ONLY_VISIBLE_USERS_CAN_BE_REMOVED 16#5009 Only visible users can be removed ERR_VUM_EMPTY_PASSWORD_NOT_ALLOWED 16#500A An empty password is not allowed ERR_VUM_ANOTHER_CLIENT_EDITS_UM 16#500B Only one client can edit user management entries ERR_VUM_SYSFILE_ERROR 16#500C Error during working with SysFile ERR_VUM_SETNEWUSERDB_FAILED 16#500D Set new user database failed ERR_VUM_PROXY_IS_NOT_IN_IDLE_MODE 16#500E Proxy is not in idle mode ERR_VUM_DATASERVER_ERROR 16#500F DataServer ProcessDataServerRequest error ERR_VUM_DATASERVER_ERROR_USERS 16#5010 The user list cannot be read from the remote system ERR_VUM_MAX_GROUP_LIMIT 16#5011 The maximum number of possible groups is exceeded ERR_VUM_USER_DOES_NOT_EXIST 16#5012 The user does not exist ERR_VUM_USER_IS_INACTIVE 16#5013 The user is inactive ERR_VUM_NO_LOGIN_PROVIDER_AVAILABLE 16#5014 The login dialog cannot be opened because the maximum number of login dialogs is reached ERR_VUM_NO_CLIENT_MEMORY 16#5015 No client memory ERR_VUM_NO_USER_LOGGED_IN 16#5016 No user logged in ERR_VUM_NO_VALID_USERGROUP_SET 16#5017 No valid user group set ERR_VUM_NO_RIGHT_TO_CHANGE_USERS 16#5018 No right to change users ERR_VUM_NO_USER_MANAGEMENT 16#5019 No user management ERR_VUM_USER_NOT_IN_USER_GROUP 16#501A The user does not belong to the user group

VUM_User (STRUCT) ¶ TYPE VUM_User : STRUCT InOut: Name Type Comment wstUserName WSTRING(79) The user name which must be unique wstFullName WSTRING(79) A free full name of the user wstPassword WSTRING(79) The password which should be used to generate the md5hash md5Hash ARRAY [0..15] OF BYTE The md5hash of the password dwUserGroupID DWORD The user group id abyUserGroupIDs ARRAY [0..VISU_VUM_MAX_GROUPS_PER_USER] OF BYTE Additional user group ids if the user belongs to several groups byUserGroupCount BYTE Number of additional user groups bDeactivated BOOL Is the user deactivated

VisuUserManagement ¶ IVisuUserManagement (Interface) CheckLogin (Method) CheckLoginWithGroupID (Method) RegisterExternalUserDatabaseProvider (Method) IVisuUserManagement2 (Interface) LoginToUserGroup (Method) LoginToUserGroups (Method)

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)