PMDF popstore & MessageStore Manager's Guide


Previous Next Contents Index

4.3.4.14 rename_user Command: rename a user account

The rename_user command changes the username associated with an account. No other attribute of the account is changed. Parameter names and associated values accepted by the command are listed in Table 4-18.

Table 4-18 rename_user command parameters
parameter=value   Description
log=bvalue Optional Boolean value, 0 or 1. When bvalue is 1, then a status message will be output indicating a successful operation. The default is bvalue=0. Note that errors are always reported.
on_error=file-spec Required Name of the formatting file to use to format the results when the command fails.
on_success=file-spec Required Name of the formatting file to use to format the results when the command succeeds.
username=string Required The first instance of this parameter gives the old username and the second instance gives the new username. string has a maximum length of 32 bytes.

The username parameter must appear twice in the command. The first instance, when reading the command from left to right, gives the name of the account to rename. The second instance gives the new name to assign to the account.

As an example, consider the command


command=rename_user&username=jdoe&username=jane.doe& 
  success_format=rename_success.txt&error_format=rename_error.txt 
which renames the account jdoe to jane.doe.


Previous Next Contents Index