UserSetStr

Sets the value of the given field for the given user record in the project configuration (users.dbf ) on the local machine.

After this function has been called, use the function UserUpdateRecord to update the user record on the running system.

An alarm server needs to be configured and running in the project, so that all clients are notified that an online change to the users configuration has been completed.

In order to perform user configuration changes online in a system with multiple computers running SCADA nodes using these functions, you will need to use the RUN and COPY parameters to check the updates are distributed throughout the system, and that the functions are called from the computer which uses the COPY path as its RUN path.

Note: Only those users assigned the role with "Manage User" privilege set to True can update other users details. The current logged in user can only update their own details. Other users attempting to run will encounter an error.

Syntax

UserSetStr(sName, sField, sData)

sName:

The name of the user who's configuration record we wish to modify.

sField:

The name of the field in users.dbf to modify.

sData:

The new value of the field.

Return Value

0 (zero) if successful, otherwise an error code is returned.

Related Functions

UserDelete, UserEditForm, UserPassword, UserPasswordForm, UserCreateForm

Example

UserSetStr("Fred", "Comment", "Fred is an engineer");

UserUpdateRecord();

See Also

Security Functions