Cicode Programming Reference > Cicode Function Categories > Security Functions > UserUpdateRecord

UserUpdateRecord

Triggers a recompile of the local project configuration, then notifies the running system that user configuration has been modified and needs to be reloaded.

Use this function in conjunction with UserSetStr to modify user configuration online.

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 it's RUN path.

This function is a blocking function. It blocks the calling Cicode task until the operation is complete.

Syntax

UserUpdateRecord()

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

Published June 2018