Renames an existing user.
Syntax
ESS_FUNC_M EssRenameUser (hCtx, OldName, NewName);
Parameter | Data Type | Description |
---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
OldName | ESS_STR_T | Old name of existing user to rename. |
NewName | ESS_STR_T | New name for renamed user. See User Name Limits. |
Notes
The specified new user name must not already exist.
Return Value
None.
Access
This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.
Example
ESS_FUNC_M ESS_RenameUser (ESS_HCTX_T hCtx) { ESS_FUNC_M sts = ESS_STS_NOERR; ESS_STR_T OldName; ESS_STR_T NewName; OldName = "Jim Smith"; NewName = "Tom Smith"; sts = EssRenameUser (hCtx, OldName, NewName); return (sts); }
See Also