IVisuUserMgmt3 ¶ ChangeUser3 (Method) ChangeUserPassword3 (Method) CheckAdminRights (Method) CheckGroups (Method) GetUserCount3 (Method) GetUsers3 (Method) LoginRts (Method)
VisuUserMgmt.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)
VisuUserMgmt.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
VisuUserMgmt.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
VisuUserMgmt.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
VisuUserMgmt.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
VisuUserMgmt.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
IVisuUserManagement ¶ CheckLogin (Method) CheckLoginWithGroupID (Method) RegisterExternalUserDatabaseProvider (Method)
VisuUserMgmt.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues This method checks whether the user is in the database and the password is correct. It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues 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
VisuUserMgmt.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. It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues 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
