# EssDeleteUser

Description

EssDeleteUser() deletes an existing user.

Syntax

    ESS_FUNC_M EssDeleteUser (hCtx, UserName);

ESS_HCTX_T | hCtx
ESS_STR_T | UserName

Parameters

hCtx | Essbase API context handle.
UserName | Name of user to delete.

Return Value

None.

Notes

- The caller may not delete either their own user or the last supervisor on the server.

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_DeleteUser (ESS_HCTX_T  hCtx)
    {
       ESS_FUNC_M     sts = ESS_STS_NOERR;
       ESS_STR_T     UserName;
       UserName = "Jim Smith";

       sts = EssDeleteUser (hCtx, UserName);

      return (sts);
    }

See Also

EssCreateUser()
EssListUsers()
EssRenameUser()