VisuUserMgmt.GetGroupCount (METH) ¶ METHOD GetGroupCount : DWORD InOut: Scope Name Type Return GetGroupCount DWORD
VisuUserMgmt.GetGroupFromID (METH) ¶ METHOD GetGroupFromID : POINTER TO VUM_UserGroup InOut: Scope Name Type Return GetGroupFromID POINTER TO VUM_UserGroup Input dwGroupID DWORD
VisuUserMgmt.GetGroupIDFromIndex (METH) ¶ METHOD GetGroupIDFromIndex : DWORD InOut: Scope Name Type Return GetGroupIDFromIndex DWORD Input udiIndex DWORD
VisuUserMgmt.GetGroupIndexFromID (METH) ¶ METHOD GetGroupIndexFromID : DWORD InOut: Scope Name Type Return GetGroupIndexFromID DWORD Input dwGroupID DWORD
VisuUserMgmt.GetGroupNameFromID (METH) ¶ METHOD GetGroupNameFromID : WSTRING InOut: Scope Name Type Return GetGroupNameFromID WSTRING Input dwGroupID DWORD
VisuUserMgmt.GetLastError (METH) ¶ METHOD GetLastError : UDINT InOut: Scope Name Type Return GetLastError UDINT
IVisuUserManagement3.Login (METH) ¶ METHOD Login : VUM_ReturnValues It executes the login It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. In the case of logging in a user what needs to change the password at the first login, the error returned error will be VUM_ReturnValues.ERR_CHANGE_PASSWORD The caller of this method is responsible for handling the error code regarding changing of password, no automatism will be triggered to force a password change see VUM_ReturnValues (ENUM) where possible error reasons are described. InOut: Scope Name Type Comment Return Login VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData wstUserName WSTRING(79) The user name wstPassword WSTRING(79) The password of the user Output wstFullNameIfAvailable WSTRING The full name of the user, it it’s available dwUserGroupID DWORD The group id where the user belongs to adwUserGroupIDs ARRAY [0..VUM_Constants.VISU_VUM_MAX_GROUPS_PER_USER] OF DWORD Array of user group ids. In the first entry there’s the user group id, same of dwUserGroupID dwUserGroupCount DWORD Number of additional user groups bDeactivated BOOL Is the user deactivated
IVisuUserManagement3.Logout (METH) ¶ METHOD Logout : VUM_ReturnValues It executes the logout It works with both legacy and runtime-based user managements 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 Logout VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData
IVisuUserManagement3.UserCount (METH) ¶ METHOD UserCount : UDINT Returns the number of all available users. It works with both legacy and runtime-based user management InOut: Scope Name Type Comment Return UserCount UDINT Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData Output result VUM_ReturnValues
IVisuUserManagement3.Users (METH) ¶ METHOD Users : VUM_ReturnValues Returns the users in a specified range It works with both legacy and runtime-based user management 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 Users VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData 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_User2 The user data which should be filled udiArrSize UDINT The size of the given user array