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
VisuUserMgmt.RegisterExternalUserDatabaseProvider (METH) ¶ METHOD RegisterExternalUserDatabaseProvider : VUM_ReturnValues InOut: Scope Name Type Return RegisterExternalUserDatabaseProvider VUM_ReturnValues Input itfExtenalUserDatabaseProvider IExternalUserDatabaseProvider
IVisuUserManagement2 ¶ LoginToUserGroup (Method) LoginToUserGroups (Method)
VisuUserMgmt.LoginToUserGroup (METH) ¶ METHOD LoginToUserGroup : BOOL With this method a programmatic login for a specific visualization client can be executed for one specific user group. 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 LoginToUserGroup BOOL Input pClient POINTER TO BYTE dwGroupId DWORD wstUserName WSTRING(79) wstFullName WSTRING(79)
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.SetNewUserDB (METH) ¶ METHOD SetNewUserDB : BOOL InOut: Scope Name Type Return SetNewUserDB BOOL Input dwUserDB DWORD bResultOK BOOL
VisuUserMgmt.State (PROP) ¶ PROPERTY State : EVisuUserMgmtState
