PocketPlanner Programmer's Guide

Schedule.GetFreePeriod Method (DateTime, DateTime, TimeSpan, LocationCollection)

See Also

Returns the next period with the specified duration after the specified date, which is not occupied by items associated with the specified locations.

Namespace: MindFusion.Scheduling
Assembly: PocketPlanner

 Syntax

C#

public DateTime GetFreePeriod (
    DateTime from,
    DateTime to,
    TimeSpan duration,
    LocationCollection locations
)

Visual Basic

Public Function GetFreePeriod ( _
    from As DateTime, _
    to As DateTime, _
    duration As TimeSpan, _
    locations As LocationCollection _
) As DateTime

 Parameters

from
The start date of the interval in which to search for a free period.
to
The end date of the interval in which to search for a free period.
duration
The required minimum duration of the period.
locations
The locations whose items should be considered when looking for the free period.

 Return Value

A .NET DateTime object representing the start time of the period found or DateTime.MinValue if none.

 Remarks

If there are recurring items associated with a resource in the specified collection, the function execution might take very long if a period with the specified duration doesn't exist.

 See Also