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

Deletes a single event or a set of repeating events depending on the option chosen by the user.

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

Syntax

C#
public int DeleteEvent(
	int eventId,
	DBConstants..::.ProcessWhichEvent whichEvent,
	int userId,
	bool isAdmin
)
Visual Basic (Declaration)
Public Function DeleteEvent ( _
	eventId As Integer, _
	whichEvent As DBConstants..::.ProcessWhichEvent, _
	userId As Integer, _
	isAdmin As Boolean _
) As Integer
Visual C++
public:
int DeleteEvent(
	int eventId, 
	DBConstants..::.ProcessWhichEvent whichEvent, 
	int userId, 
	bool isAdmin
)

Parameters

eventId
Type: System..::.Int32
Id of the event to be deleted.
whichEvent
Type: OfficeClip.DBLayer..::.DBConstants..::.ProcessWhichEvent
The type of event to be deleted
userId
Type: System..::.Int32
The unique id of the user
isAdmin
Type: System..::.Boolean
Is the current user an administrator

Return Value

Enumerated value of ProcessWhichEvent type signifying whether to Delete just one single event, all events (repeating instances including) or only remaining future occurrences of repeating events.

See Also