VisuCreateUserMgmtObjects (FUN) ¶ FUNCTION VisuCreateUserMgmtObjects : RTS_IEC_RESULT It’s an helper used to create objects in RTS, these are used in visu user management runtime based It returns the first error found InOut: Scope Name Type Comment Return VisuCreateUserMgmtObjects RTS_IEC_RESULT Input pUserGroups POINTER TO ARRAY [0..0] OF VUM_UserGroup Where get the object name, it’s the group name iArraySize INT How many structures are present in the above array psAppName POINTER TO WSTRING Application name
VisuUserMgmtHasUserRightToChangeUsers (FUN) ¶ FUNCTION VisuUserMgmtHasUserRightToChangeUsers : BOOL InOut: Scope Name Type Return VisuUserMgmtHasUserRightToChangeUsers BOOL Input pvumUser POINTER TO VUM_User itfVisuUserMgmt IVisuUserMgmt
IVisuUserMgmt2.CurrentUserLockoutTime (PROP) ¶ PROPERTY CurrentUserLockoutTime : INT A user is lockedout right now. Get/set the lockout time duration
IVisuUserMgmt3 (ITF) ¶ INTERFACE IVisuUserMgmt3 EXTENDS IVisuUserMgmt2 extension for runtime based user management Properties: CheckUserWithTempLockout , inherited from IVisuUserMgmt2 CurrentUserLockoutTime , inherited from IVisuUserMgmt2 LastResult , inherited from IVisuUserMgmt State , inherited from IVisuUserMgmt Methods: ChangeUser3 ChangeUserPassword3 CheckAdminRights CheckGroups GetUserCount3 GetUsers3 LoginRts ChangeUser , inherited from IVisuUserMgmt ChangeUserPassword , inherited from IVisuUserMgmt CheckLoginIntern , inherited from IVisuUserMgmt CheckTemporaryLockedUser , inherited from IVisuUserMgmt2 FillLanguageGroupNames , inherited from IVisuUserMgmt GetCurrentUser , inherited from IVisuUserMgmt GetGroupCount , inherited from IVisuUserMgmt GetGroupFromID , inherited from IVisuUserMgmt GetGroupIDFromIndex , inherited from IVisuUserMgmt GetGroupIndexFromID , inherited from IVisuUserMgmt GetLastError , inherited from IVisuUserMgmt GetTextIdFromGroupID , inherited from IVisuUserMgmt GetUserCount , inherited from IVisuUserMgmt GetUserDBAsCopy , inherited from IVisuUserMgmt GetUsers , inherited from IVisuUserMgmt RegisterExternalUserDatabaseProvider , inherited from IVisuUserMgmt SetLastError , inherited from IVisuUserMgmt SetNewUserDB , inherited from IVisuUserMgmt SetProvider , inherited from IVisuUserMgmt Structure: ChangeUser3 (Method) ChangeUserPassword3 (Method) CheckAdminRights (Method) CheckGroups (Method) GetUserCount3 (Method) GetUsers3 (Method) LoginRts (Method)
IVisuUserMgmt3.ChangeUser3 (METH) ¶ METHOD ChangeUser3 : 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 ChangeUser3 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_User The user data with new data pvumUserOld POINTER TO VUM_User The user data with old data udiIndex UDINT Index to use for user list eEditType VUM_EditType Activity to do (only for legacy)
IVisuUserMgmt3.ChangeUserPassword3 (METH) ¶ METHOD ChangeUserPassword3 : UDINT Changes on a user password. InOut: Scope Name Type Comment Return ChangeUserPassword3 UDINT 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 wstUserName WSTRING wstNewPassword WSTRING wstOldPassword WSTRING
IVisuUserMgmt3.CheckAdminRights (METH) ¶ METHOD CheckAdminRights : VUM_UserAdminAccess It checks what kind of administrator rights the current user has InOut: Scope Name Type Return CheckAdminRights VUM_UserAdminAccess Input pClientData POINTER TO VisuElems.VisuStructClientData
IVisuUserMgmt3.CheckGroups (METH) ¶ METHOD CheckGroups : BOOL It checks if all teh groups have the correct mapping It returns TRUE for NOT correct groups configuration InOut: Scope Name Type Return CheckGroups BOOL Input pClientData POINTER TO VisuElems.VisuStructClientData
IVisuUserMgmt3.GetUserCount3 (METH) ¶ METHOD GetUserCount3 : UDINT Gets the number of users InOut: Scope Name Type Comment Return GetUserCount3 UDINT 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 Output result RTS_IEC_RESULT
IVisuUserMgmt3.GetUsers3 (METH) ¶ METHOD GetUsers3 : DWORD Gets the users InOut: Scope Name Type Comment Return GetUsers3 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_User The user data which should be filled udiArrSize UDINT The size of the given user array
