Visu Interfaces Library Documentation ¶ Company : System Title : Visu Interfaces Version : 4.5.0.0 Categories : Intern|Visu Namespace : Visu_Interfaces Author : CODESYS Development GmbH Description [ 1 ] ¶ This library defines the interfaces the visualization consists of. Contents: ¶ IGlobalClientManagerListener (Interface) ClientCreated (Method) ClientDestroyed (Method) IVisuGlobalClientManager2 (Interface) AddGlobalClientManagerListener (Method) IVisuGlobalClientManager3 (Interface) UnregisterClient (Method) Indices and tables ¶ [ 1 ] Based on Visu_Itfs.library, last modified 13.12.2023, 11:15:39. LibDoc 4.4.0.0-b.37 The content file Visu_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 13.12.2023, 11:15:40.
IGlobalClientManagerListener (ITF) ¶ INTERFACE IGlobalClientManagerListener EXTENDS __SYSTEM.IQueryInterface This interface must be implemented by function blocks, that want to be notified if a client is created or destroyed. Methods: ClientCreated ClientDestroyed Structure: ClientCreated (Method) ClientDestroyed (Method)
IGlobalClientManagerListener.ClientCreated (METH) ¶ METHOD ClientCreated Notification, that a client has been created. InOut: Scope Name Type Comment Input iGlobalClientID INT The global id of the client eVisuClientType Visu_ClientTypeItf The type of the client
IGlobalClientManagerListener.ClientDestroyed (METH) ¶ METHOD ClientDestroyed Notification, that a client has been destroyed InOut: Scope Name Type Comment Input iGlobalClientID INT The global id of the client eVisuClientType Visu_ClientTypeItf The type of the client
IVisuGlobalClientManager2 (ITF) ¶ INTERFACE IVisuGlobalClientManager2 EXTENDS IVisuGlobalClientManager the interface of the global client manager can be used to register globally visualization clients of all types which become a zero based unique client id Methods: AddGlobalClientManagerListener Structure: AddGlobalClientManagerListener (Method)
IVisuGlobalClientManager2.AddGlobalClientManagerListener (METH) ¶ METHOD AddGlobalClientManagerListener : BOOL Adds an IGlobalClientManagerListener instance that will be notified when a client is created or destroyed. Returns TRUE if the IGlobalClientManagerListener instance could be added successfully. InOut: Scope Name Type Comment Return AddGlobalClientManagerListener BOOL Input itfGlobalClientManagerListener IGlobalClientManagerListener IGlobalClientManagerListener instance to add
IVisuGlobalClientManager3 (ITF) ¶ INTERFACE IVisuGlobalClientManager3 EXTENDS IVisuGlobalClientManager2 the interface of the global client manager can be used to register globally visualization clients of all types which become a zero based unique client id Methods: UnregisterClient AddGlobalClientManagerListener , inherited from IVisuGlobalClientManager2 Structure: UnregisterClient (Method)
IVisuGlobalClientManager3.UnregisterClient (METH) ¶ METHOD UnregisterClient : BOOL This method can be used to unregister a client (iGlobalClientID must be <> VISU_INVALID_ID). InOut: Scope Name Type Return UnregisterClient BOOL Input iGlobalClientID INT eVisuClientType Visu_ClientTypeItf
IExternalUserDatabaseProvider.ChangeUserPassword (METH) ¶ METHOD ChangeUserPassword : VUM_ReturnValues Changes the password of a given user. 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 ChangeUserPassword VUM_ReturnValues Input wstUserName WSTRING the user name wstNewPassword WSTRING the new password of the user wstOldPassword WSTRING the old password of the user
IExternalUserDatabaseProvider.CheckLogin (METH) ¶ METHOD CheckLogin : VUM_ReturnValues Checks whether the user name and 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 Output wstFullName WSTRING the full name of the user dwUserGroupID DWORD the group id where the user belongs to
