[This is preliminary documentation and is subject to change.]

Removes a given member from a particular group based on the userDetailId.

Namespace:  OfficeClip.DBLayer.Account
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public int RemoveMember(
	int userId,
	int groupId,
	bool sendNotification,
	string groupName,
	string fromName,
	string fromEmailAddress,
	int currentUserId
)
Visual Basic (Declaration)
Public Function RemoveMember ( _
	userId As Integer, _
	groupId As Integer, _
	sendNotification As Boolean, _
	groupName As String, _
	fromName As String, _
	fromEmailAddress As String, _
	currentUserId As Integer _
) As Integer
Visual C++
public:
int RemoveMember(
	int userId, 
	int groupId, 
	bool sendNotification, 
	String^ groupName, 
	String^ fromName, 
	String^ fromEmailAddress, 
	int currentUserId
)

Parameters

userId
Type: System..::.Int32
The unique id of the user.
groupId
Type: System..::.Int32
The group id corresponding to the UserDetail ID for a given group.
sendNotification
Type: System..::.Boolean
Flag to indicate whether to send an email notification or not.
groupName
Type: System..::.String
The name of the group from who the email address will be sent
fromName
Type: System..::.String
The name from who the email will be sent
fromEmailAddress
Type: System..::.String
The email address from who the email will be sent
currentUserId
Type: System..::.Int32
The current user id

Return Value

0 if it is successful, -1 In case the user is the only admin in the group, -2 if there is an error sending the email

See Also