Removes the specified event from the list.
Namespace:
GrassValley.Mseries.ScheduleEditorAssembly: GrassValley.Mseries.ScheduleEditor (in GrassValley.Mseries.ScheduleEditor.dll) Version: 1.0.0.0
Syntax
C# |
---|
void RemoveEvent( string eventId ) |
Visual Basic (Declaration) |
---|
Sub RemoveEvent ( _ eventId As String _ ) |
Visual C++ |
---|
void RemoveEvent( String^ eventId ) |
Parameters
- eventId
- Type: System..::.String
The event id.
Remarks
This function will generate a list change notice of type NoticeDeleteEvent
as well as a notice for changes to every child event of this event.
Examples
CopyC#
//Call helper function CreateIScheduleEditor which creates editor object IScheduleEditor schEditor = CreateIScheduleEditor(); string eventID = "some event ID"; schEditor.RemoveEvent(eventID);