UtilFillLanguageGroupNames (FUN) ¶ FUNCTION UtilFillLanguageGroupNames : BOOL InOut: Scope Name Type Return UtilFillLanguageGroupNames BOOL Input parrUserGroupTextIds POINTER TO ARRAY [0..0] OF DWORD dwArraySize DWORD
VisuAssignRtsBasedUserMgt (FB) ¶ FUNCTION_BLOCK VisuAssignRtsBasedUserMgt FB used to inform the RTS about the type of visu user management set in the IEC application: visu or runtime based This information is passed to the RTS in FB_Init and FB_Exit Methods: FB_Exit FB_Init Structure: FB_Exit (Method) FB_Init (Method)
VisuAssignRtsBasedUserMgt.FB_Exit (METH) ¶ METHOD FB_Exit : BOOL FB_Exit must be implemented explicitly. If there is an implementation, then the method is called before the controller removes the code of the function block instance (implicit call). The return value is not evaluated. InOut: Scope Name Type Comment Return FB_Exit BOOL Input bInCopyCode BOOL TRUE: the exit method is called in order to leave the instance which will be copied afterwards (online change).
VisuAssignRtsBasedUserMgt.FB_Init (METH) ¶ METHOD FB_Init : BOOL FB_Init is always available implicitly and it is used primarily for initialization. The return value is not evaluated. For a specific influence, you can also declare the methods explicitly and provide additional code there with the standard initialization code. You can evaluate the return value. InOut: Scope Name Type Comment Return FB_Init BOOL Input bInitRetains BOOL TRUE: the retain variables are initialized (reset warm / reset cold) bInCopyCode BOOL TRUE: the instance will be copied to the copy code afterward (online change)
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