VisuUserMgmt.LoginToUserGroups (METH) ¶ METHOD LoginToUserGroups : BOOL With this method a programmatic login for a specific visualization client can be executed for a list of user groups. It does NOT check if the credentials are ok. It works with both legacy and runtime-based user management If everything is correct the function returns TRUE. InOut: Scope Name Type Return LoginToUserGroups BOOL Input pClient POINTER TO BYTE padwUserGroupIds POINTER TO ARRAY [0..0] OF DWORD dwUserGroupCount DWORD wstUserName WSTRING(79) wstFullName WSTRING(79)
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
VisuUserMgmt.LoginRts (METH) ¶ METHOD LoginRts : UDINT It does a login in RTS InOut: Scope Name Type Return LoginRts UDINT Input wstUserName WSTRING wstPassword WSTRING pClientData POINTER TO VisuElems.VisuStructClientData pUser POINTER TO VUM_User Output wstFullName WSTRING dwUserGroupID DWORD
IVisuUserMgmt4 ¶ ChangeUser4 (Method) GetUsers4 (Method) LogoutRts (Method)
VisuUserMgmt.ChangeUser4 (METH) ¶ METHOD ChangeUser4 : BOOL Changes on a user database. The edit type can be: VUM_MODIFY, VUM_ADD, VUM_REMOVE AND VUM_INSERT For runtime-based usermanagement VUM_ADD and VUM_INSERT do the same. 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 (only for legacy. Needed for VUM_MODIFY, VUM_REMOVE AND VUM_INSERT) eEditType VUM_EditType Activity to do
VisuUserMgmt.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
VisuUserMgmt.LogoutRts (METH) ¶ METHOD LogoutRts It does a logout in RTS InOut: Scope Name Type Input pClientData POINTER TO VisuElems.VisuStructClientData
VisuUserMgmt.Initialize (METH) ¶ METHOD Initialize : BOOL InOut: Scope Name Type Return Initialize BOOL Input parrUserGroups POINTER TO ARRAY [0..0] OF VUM_UserGroup parrUserGroupTextIds POINTER TO ARRAY [0..0] OF DWORD dwArraySize DWORD
VisuUserMgmt.EditUser (METH) ¶ METHOD EditUser : VUM_ReturnValues It edit the user data. It works with both legacy and runtime-based user management Only users of group ADMIN can edit other user. Following actions (eEditType) are possible: VUM_MODIFY, VUM_REMOVE, VUM_ADD and VUM_INSERT. (VUM_ADD and VUM_INSERT do the same for runtime-based usermanagement.) 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 EditUser VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData pvumUserNew POINTER TO VUM_User3 The user data with new data. Needed for VUM_MODIFY, VUM_REMOVE, VUM_ADD and VUM_INSERT. pvumUserOld POINTER TO VUM_User3 The user data with old data, only needed for VUM_MODIFY. udiIndex UDINT Only for legacy Index to use for user list (for VUM_INSERT, VUM_MODIFY and VUM_REMOVE) eEditType VUM_EditType Activity to do
IVisuUserMgmt methods ¶ SetProvider (Method)
