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
IExternalUserDatabaseProvider.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 Output wstFullName WSTRING the full name of the user
IExternalUserDatabaseProvider.ChangeUser (METH) ¶ METHOD ChangeUser : VUM_ReturnValues Changes on a user database. The edit type can be: VUM_MODIFY, VUM_ADD, VUM_REMOVE AND VUM_INSERT 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 ChangeUser VUM_ReturnValues Input pvumUser POINTER TO VUM_User The new user data udiIndex UDINT The index of this edit operation eEditType VUM_EditType The type of this edit operation
IExternalUserDatabaseProvider.GetUserCount (METH) ¶ METHOD GetUserCount : UDINT Returns the number of all available users. InOut: Scope Name Type Return GetUserCount UDINT
IExternalUserDatabaseProvider.GetUsers (METH) ¶ METHOD GetUsers : VUM_ReturnValues Returns the users in a specified range 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 GetUsers VUM_ReturnValues Input 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
