AppointmentStore.FindAppointmentsAsync Method

Definition

Namespace:

Windows.ApplicationModel.Appointments

Overloads

FindAppointmentsAsync(DateTime, TimeSpan)	Retrieves a list of appointments in the appointment calendar that fall within the specified date range.
FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)	Retrieves a list of appointments in the appointment calendar that fall within the specified date range and meet the criteria specified by the supplied FindAppointmentsOptions object..

FindAppointmentsAsync(DateTime, TimeSpan)

Retrieves a list of appointments in the appointment calendar that fall within the specified date range.

public:
 virtual IAsyncOperation<IVectorView<Appointment ^> ^> ^ FindAppointmentsAsync(DateTime rangeStart, TimeSpan rangeLength) = FindAppointmentsAsync;

/// [Windows.Foundation.Metadata.Overload("FindAppointmentsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<Appointment>> FindAppointmentsAsync(DateTime const& rangeStart, TimeSpan const& rangeLength);

[Windows.Foundation.Metadata.Overload("FindAppointmentsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<Appointment>> FindAppointmentsAsync(System.DateTimeOffset rangeStart, System.TimeSpan rangeLength);

function findAppointmentsAsync(rangeStart, rangeLength)

Public Function FindAppointmentsAsync (rangeStart As DateTimeOffset, rangeLength As TimeSpan) As IAsyncOperation(Of IReadOnlyList(Of Appointment))

Parameters

rangeStart

DateTime DateTimeOffset

The start of the date range for which appointments are retrieved.

rangeLength

TimeSpan TimeSpan

The length of the date range for which appointments are retrieved. If the rangeLength parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the rangeStart value, the returned list will be empty.

Returns

IAsyncOperation<IVectorView<Appointment>>

IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

App capabilities

appointmentsSystem

See also

• FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)
• Appointment

FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)

Retrieves a list of appointments in the appointment calendar that fall within the specified date range and meet the criteria specified by the supplied FindAppointmentsOptions object..

public:
 virtual IAsyncOperation<IVectorView<Appointment ^> ^> ^ FindAppointmentsAsync(DateTime rangeStart, TimeSpan rangeLength, FindAppointmentsOptions ^ options) = FindAppointmentsAsync;

/// [Windows.Foundation.Metadata.Overload("FindAppointmentsAsyncWithOptions")]
IAsyncOperation<IVectorView<Appointment>> FindAppointmentsAsync(DateTime const& rangeStart, TimeSpan const& rangeLength, FindAppointmentsOptions const& options);

[Windows.Foundation.Metadata.Overload("FindAppointmentsAsyncWithOptions")]
public IAsyncOperation<IReadOnlyList<Appointment>> FindAppointmentsAsync(System.DateTimeOffset rangeStart, System.TimeSpan rangeLength, FindAppointmentsOptions options);

function findAppointmentsAsync(rangeStart, rangeLength, options)

Public Function FindAppointmentsAsync (rangeStart As DateTimeOffset, rangeLength As TimeSpan, options As FindAppointmentsOptions) As IAsyncOperation(Of IReadOnlyList(Of Appointment))

Parameters

rangeStart

DateTime DateTimeOffset

The start of the date range for which appointments are retrieved.

rangeLength

TimeSpan TimeSpan

The length of the date range for which appointments are retrieved. If the rangeLength parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the rangeStart value, the returned list will be empty.

options

FindAppointmentsOptions

A FindAppointmentsOptions object that is used to specify more options for this operation. You must set the options parameter to specify the values to retrieve.

Returns

IAsyncOperation<IVectorView<Appointment>>

IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Attributes

OverloadAttribute

Windows requirements

App capabilities

appointmentsSystem

Examples

Set FindAppointmentOptions.FetchProperties to specify the values to retrieve.

AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly);

// Specify which values to retrieve
FindAppointmentsOptions options = new FindAppointmentsOptions(); 
options.FetchProperties.Add(AppointmentProperties.Subject); 
options.FetchProperties.Add(AppointmentProperties.Details); 
options.FetchProperties.Add(AppointmentProperties.DetailsKind);

var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options);

foreach (var i in iteratingAppointments) 
{ 
  // do stuff with each appointment 
}

Remarks

Important

For performance reasons, FindAppointmentsAsync will not load most properties. To load specific properties, add values to the FindAppointmentsOptions.FetchProperties member in the options parameter. See the example below for more info.

See also

• FindAppointmentsAsync(DateTime, TimeSpan)
• Appointment