SwapWord (FUN) ¶ FUNCTION SwapWord : BOOL InOut: Scope Name Type Return SwapWord BOOL Inout wd WORD
ITrendStorageAccessReadOperator.BeforeReadingVariableConfiguration (METH) ¶ METHOD BeforeReadingVariableConfiguration Notification, that reading the variable configuration from table TblTrendConfiguration will start. InOut: Scope Name Type Comment Input iWhichCall INT The 0-based index of the reading, i.e. of call to method prvTblTrendConfigurationGetConfig xChangeOfConfig BOOL This flag indicates, whether the given timestamp range of method Read spans more than one configuration, i.e. subsequent calls to method prvTblTrendConfigurationGetConfig will be done. iCountVariables INT The number of variables of the corresponding trace manager packet, that will be read by method prvTblTrendConfigurationGetConfig
ITrendStorageAccessReadOperator.ColIDRead (METH) ¶ METHOD ColIDRead Notification, that the column id of the column, that stores the values of the variable was read from table TblTrendConfiguration. InOut: Scope Name Type Comment Input iWhichVariable INT The 0 based index of the variable within all variables wColId WORD The column id
ITrendStorageAccessReadOperator.DescriptionTextIDRead (METH) ¶ METHOD DescriptionTextIDRead Notification, that the text ID for the description of the variable was read from table TblTrendConfiguration. InOut: Scope Name Type Comment Input iWhichVariable INT The 0 based index of the variable within all variables sDescriptionTextID STRING The text ID
ITrendStorageAccessReadOperator.DisplayVariableNameRead (METH) ¶ METHOD DisplayVariableNameRead Notification, that the flag “display variable name” was read from table TblTrendConfiguration. InOut: Scope Name Type Comment Input iWhichVariable INT The 0 based index of the variable within all variables xDisplayVariableName BOOL The value of the flag
IVisuUserManagement3 ¶ ChangePassword (Method) Login (Method) Logout (Method) UserCount (Method) Users (Method)
VisuUserMgmt.ChangePassword (METH) ¶ METHOD ChangePassword : VUM_ReturnValues It chenges the user password 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 ChangePassword VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData wstUserName WSTRING(79) The user name wstNewPassword WSTRING(79) The new password wstOldPassword WSTRING(79) The old password
VisuUserMgmt.Login (METH) ¶ METHOD Login : VUM_ReturnValues It executes the login It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. In the case of logging in a user what needs to change the password at the first login, the error returned error will be VUM_ReturnValues.ERR_CHANGE_PASSWORD The caller of this method is responsible for handling the error code regarding changing of password, no automatism will be triggered to force a password change see VUM_ReturnValues where possible error reasons are described. InOut: Scope Name Type Comment Return Login VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData wstUserName WSTRING(79) The user name wstPassword WSTRING(79) The password of the user Output wstFullNameIfAvailable WSTRING The full name of the user, it it’s available dwUserGroupID DWORD The group id where the user belongs to adwUserGroupIDs ARRAY [0..VUM_Constants.VISU_VUM_MAX_GROUPS_PER_USER] OF DWORD Array of user group ids. In the first entry there’s the user group id same of dwUserGroupID dwUserGroupCount DWORD Number of additional user groups bDeactivated BOOL Is the user deactivated
VisuUserMgmt.Logout (METH) ¶ METHOD Logout : VUM_ReturnValues It does the logout It works with both legacy and runtime-based user managements 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 Logout VUM_ReturnValues Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData
VisuUserMgmt.UserCount (METH) ¶ METHOD UserCount : UDINT Returns the number of all available users. It works with both legacy and runtime-based user management InOut: Scope Name Type Comment Return UserCount UDINT Input pClient POINTER TO BYTE A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData Output result VUM_ReturnValues