# EssGetUser

Description

EssGetUser() gets a user information structure, which contains security information for the user.

Syntax

    ESS_FUNC_M EssGetUser (hCtx, UserName, ppUserInfo);

ESS_HCTX_T | hCtx
ESS_STR_T | UserName
ESS_PPUSERINFO_T | ppUserInfo

Parameters

hCtx | Essbase API context handle.
UserName | User name.
ppUserInfo | Address of pointer to receive allocated user info structure.

Return Value

If successful, returns the user information structure in ppUserInfo.

Notes

- The memory allocated for ppUserInfo should be freed using EssFree().

Access

This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server, unless they are getting their own user information.

Example

    ESS_FUNC_M
    ESS_GetUserInfo (ESS_HCTX_T  hCtx,
                     ESS_HINST_T hInst
                    )
    {
       ESS_FUNC_M        sts  = ESS_STS_NOERR;
       ESS_PUSERINFO_T  User = NULL;

       sts = EssGetUser (hCtx, "Jim Smith", &User);
       if (!sts)
       {
          if (User)
             EssFree (hInst, User);
       }

       return (sts);
    }

See Also

EssGetApplicationAccess()
EssListUsers()
EssSetUser()