Click or drag to resize

IUserManagerRemoveUserGroup Method

Removes a User Group from the Content Store.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
Copy
bool RemoveUserGroup(
	IUserGroup userGroup
)

Parameters

userGroup
Type: Ingeniux.CMSIUserGroup
The User Group to remove

Return Value

Type: Boolean
True if "userGroup" is not null and exists, false otherwise.
Exceptions
ExceptionCondition
InvalidOperationExceptionWhen the "userGroup" is the Administrators Group, which cannot be removed
SecurityExceptionWhen the Operating User doesn't have administrative privileges.
Remarks

If the "userGroup" parameter value is null, returns false.

The Administrators Group cannot be removed.

This method fires two events: BeforeUserGroupDelete and AfterUserGroupDelete.

See Also