RemoveVarianceContext Constructor(String,String,String,SmartDate)

Creates a DataContext for a RemoveVariance operation of a recurring Activity's variance information.

Syntax

Visual Basic

'Declaration
 
Public Function New( _
   ByVal dataKey As String, _
   ByVal rootActivityKey As String, _
   ByVal recurrenceKey As String, _
   ByVal originalStartDateTimeUtc As SmartDate _
)

C#

public RemoveVarianceContext( 
   string dataKey,
   string rootActivityKey,
   string recurrenceKey,
   SmartDate originalStartDateTimeUtc
)

Parameters

dataKey

Data key of a Variance related to an Activity to have it's information marked as deleted.

rootActivityKey

Data key of a root recurring Activity to which this variance belongs. May be the same as dataKey provided an originalStartDateTimeUtc is specified and this is supported by the WebSchedule data provider.

recurrenceKey

Data key of the Recurrence attached to the Variance to be deleted. This can be optionally used by the WebSchedule data provider to locate the variance's root Activity.

originalStartDateTimeUtc

Original start date/time of the variance. This is only necessary to uniquely qualify a variance when the dataKey and rootActivityKey are identical.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when either dataKey, rootActivityKey, or recurrenceKey are supplied as null (Nothing in Visual Basic .NET) or empty strings. Both values are required to remove an instance of the variance.
System.ArgumentException	Thrown when either dataKey, rootActivityKey, or recurrenceKey do not represent a numeric value, or when the value -999 is supplied. Non-default keys are required to remove an instance of the variance.

Remarks

The WebSchedule data model gives each variance row it's own unique dataKey distinct from it's parent (or containing) rootActivityKey. The built-in WebSchedule data providers may ignore the originalStartDateTimeUtc argument.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2