Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CANopenSafetyBase ¶ Library Identification ¶ Placeholder: CANopenSafetyBase Default Resolution: CANopenSafetyBase, * (3S - Smart Software Solutions GmbH) Namespace: CSB Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CANopenSafetyBase CANopenSafetyTypes ¶ Library Identification ¶ Placeholder: CANopenSafetyTypes Default Resolution: CANopenSafetyTypes, * (3S - Smart Software Solutions GmbH) Namespace: CST Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CANopenSafetyTypes CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpSIL2 ¶ Library Identification ¶ Placeholder: CmpSIL2 Default Resolution: CmpSIL2, * (System) Namespace: CmpSIL2 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSIL2 IoDriver Interfaces ¶ Library Identification ¶ Name: IoDriver Interfaces Version: newest Company: System Namespace: IIoDrv Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDriver Interfaces, * (System) IoDriver Parameter Interfaces ¶ Library Identification ¶ Name: IoDriver Parameter Interfaces Version: newest Company: System Namespace: IIoDrvParameter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoDriver Parameter Interfaces, * (System) IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard SysExcept ¶ Library Identification ¶ Placeholder: SysExcept Default Resolution: SysExcept, * (System) Namespace: SysExcept Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysExcept SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
State Transitions ¶ Methods for switching the internal state of the state machine.
VUM_User (STRUCT) ¶ TYPE VUM_User : STRUCT InOut: Name Type Comment wstUserName WSTRING(79) The user name which must be unique wstFullName WSTRING(79) A free full name of the user wstPassword WSTRING(79) The password which should be used to generate the md5hash md5Hash ARRAY [0..15] OF BYTE The md5hash of the password dwUserGroupID DWORD The user group id abyUserGroupIDs ARRAY [0..VISU_VUM_MAX_GROUPS_PER_USER] OF BYTE Additional user group ids if the user belongs to several groups byUserGroupCount BYTE Number of additional user groups bDeactivated BOOL Is the user deactivated
VisuUserManagement ¶ IVisuUserManagement (Interface) CheckLogin (Method) CheckLoginWithGroupID (Method) RegisterExternalUserDatabaseProvider (Method) IVisuUserManagement2 (Interface) LoginToUserGroup (Method) LoginToUserGroups (Method)
IVisuUserManagement (ITF) ¶ INTERFACE IVisuUserManagement Interface to the visu user management which can be used from an IEC application Methods: CheckLogin CheckLoginWithGroupID RegisterExternalUserDatabaseProvider Structure: CheckLogin (Method) CheckLoginWithGroupID (Method) RegisterExternalUserDatabaseProvider (Method)
IVisuUserManagement.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues This method checks whether the user is in the database and the password is correct. 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 CheckLogin VUM_ReturnValues Input wstUserName WSTRING the user name wstPassword WSTRING the password of the user
IVisuUserManagement.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. 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 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
IVisuUserManagement.RegisterExternalUserDatabaseProvider (METH) ¶ METHOD RegisterExternalUserDatabaseProvider : VUM_ReturnValues This method registers an external user database provider. Only one external user database provider can be registered. see IExternalUserDatabaseProvider (ITF) 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 Return RegisterExternalUserDatabaseProvider VUM_ReturnValues Input itfExtenalUserDatabaseProvider IExternalUserDatabaseProvider
IVisuUserManagement2 (ITF) ¶ INTERFACE IVisuUserManagement2 EXTENDS IVisuUserManagement , __SYSTEM.IQueryInterface Extension of interface IVisuUserManagement which provides the functionallity to login a user from an IEC application Methods: LoginToUserGroup LoginToUserGroups CheckLogin , inherited from IVisuUserManagement CheckLoginWithGroupID , inherited from IVisuUserManagement RegisterExternalUserDatabaseProvider , inherited from IVisuUserManagement Structure: LoginToUserGroup (Method) LoginToUserGroups (Method)
IVisuUserManagement2.LoginToUserGroup (METH) ¶ METHOD LoginToUserGroup : BOOL With this method a programmatic login for a specific visualization client can be executed for one specific user group. If everything is correct the function returns TRUE. InOut: Scope Name Type Comment Return LoginToUserGroup BOOL Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData dwGroupId DWORD The user group id wstUserName WSTRING(79) The user name which is afterwards content in VisuElems.CurrentUserName wstFullName WSTRING(79) The full user name which is afterwards content in VisuElems.CurrentFullUserName