EssRenameUser

Description

EssRenameUser() renames an existing user.

Syntax

ESS_FUNC_M EssRenameUser (hCtx, OldName, NewName);
ESS_HCTX_ThCtx
ESS_STR_TOldName
ESS_STR_TNewName

Parameters

hCtxEssbase API context handle.
OldNameOld name of existing user to rename.
NewNameNew name for renamed user. User names can be up to 30 characters long.

Return Value

None.

Notes

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

EssCreateUser()
EssDeleteUser()
EssListUsers()