EssGetUser

Gets a user information structure, which contains security information for the user.

Syntax

ESS_FUNC_M EssGetUser (hCtx, UserName, ppUserInfo);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
UserName	ESS_STR_T	User name.
ppUserInfo	ESS_USERINFO_T, ESS_GROUPINFO_T	Address of pointer to receive allocated user info structure.

Notes

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

Return Value

If successful, returns the user information structure in ppUserInfo.

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);
}