Remove (NotesCalendarEntry - LotusScript®)

Removes a meeting entry or entries.

Defined in

Syntax

Call notesCalendarEntry.Remove( comments$ , [ scope% ] , [ recurid$ ] )


Parameter	Description
`scope`	Integer. The scope of a recurring operation: `CS_RANGE_REPEAT_ALL` (1) `CS_RANGE_REPEAT_CURRENT` (0) `CS_RANGE_REPEAT_FUTURE` (3), inclusive `CS_RANGE_REPEAT_PREV` (2), inclusive
`recurid`	String. The recurrence identifier (`RECURRENCE-ID` item) for a recurring calendar event. The format of a recurrence identifier is a time in UTC format, for example, `20120913T160000Z`.


Possible exception (lsxbeerr.lss)	Value	Text	Description
`lsERR_NOTES_ERR_INVALIDID`	4757	Invalid ID	The identifier for the NotesCalendarEntry object is not valid.
`lsERR_NOTES_ERR_RECURID_NOTFOUND`	4808	Recurrence-ID not found	The recurrence identifier for the NotesCalendarEntry object is not valid.
`lsERR_NOTES_ERR_IDNOTFOUND`	4814	Identifier not found	The recurrence identifier for the NotesCalendarEntry object does not identify an entry in the calendar, or the `scope` and `recurid` are missing for a recurring entry.

Usage

This method deals with meeting entries, not notices.

Usage

If AutoSendNotices is true, remove works as follows:

Deletes (hard delete) a non-meeting entry such as an appointment.
Cancels a meeting for which you are the organizer and removes it from your calendar.
Declines a meeting for which you are an invitee and removes it from your calendar.

If AutoSendNotices is false, remove deletes (hard delete) an entry.

This method deals with meeting entries, not notices.

Examples

This agent removes the entry, or all recurring entries, for a given UID.

Sub Initialize
	Dim session As New NotesSession
	Dim maildb As New NotesDatabase("", "")
	Dim cal As NotesCalendar
	Dim cale As NotesCalendarEntry
	Dim uid As String
	Dim recurid As String
		uid = session.Getenvironmentstring("currentuid")
	If uid = "" Then
		MessageBox "No current UID",, "Error"
		Exit sub
	End If
	recurid = session.Getenvironmentstring("currentrecurid")
	Call maildb.Openmail()
	Set cal = session.getCalendar(maildb)
	Set cale = cal.Getentry(uid)
	If recurid = "" Then
		Call cale.Remove()
		MessageBox "UID = " & uid,, "Removed entry"
	Else
		Call cale.Remove(recurid, Cs_range_repeat_all)
		MessageBox "UID = " & uid & ", Recur ID = " & recurid,, _
		"Removed all entry instances"
	End If
End Sub