RecurringObjectAllInstances Method

This method is used to return all recurring instances based on the current settings alone

Definition

Namespace: EWSoftware.PDI.Objects
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0

C#View Source Request Example

public DateTimeInstanceCollection AllInstances(
	bool inLocalTime
)

VBView Source Request Example

Public Function AllInstances ( 
	inLocalTime As Boolean
) As DateTimeInstanceCollection

C++View Source Request Example

public:
DateTimeInstanceCollection^ AllInstances(
	bool inLocalTime
)

F#View Source Request Example

member AllInstances : 
        inLocalTime : bool -> DateTimeInstanceCollection

Parameters

inLocalTime Boolean: If true, the date/times are returned expressed in local time. If false, they are returned expressed in the time zone of the object as specified by the TimeZoneId property. If no time zone ID has been specified or it cannot be found, local time is used.

Return Value

DateTimeInstanceCollection
Returns a DateTimeInstanceCollection containing DateTimeInstance objects that represent all instances found using the current settings. Instances may have a different duration than that of the component if created from an RDATE property.

Remarks

This is best used with recurrences that end after a specific number of occurrences or by a specific date. If set to never end, this will return a really large collection of instances.

Exceptions

ArgumentException

This is thrown if a start date has not been specified (it equals DateTime.MinValue) or the duration is negative.