EssDeleteFromGroup

Removes a user from the list of group members.

Syntax

ESS_FUNC_M EssDeleteFromGroup (hCtx, GroupName, UserName);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

GroupName

ESS_STR_T

Group name.

UserName

ESS_STR_T

Name of user to remove from group list.

Notes

As well as deleting the specified user from the list of members for the specified group, this function also deletes the group from the user's own list of associated groups.

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_RemoveUser (ESS_HCTX_T    hCtx)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_STR_T     GroupName;
   ESS_STR_T     UserName;
   GroupName = "PowerUsers";
   UserName  = "Jim Smith";
   
   sts = EssDeleteFromGroup (hCtx, GroupName, UserName);
      
   return (sts);
}

See Also