Provides partial status and results of an active busy search, and the final results of a completed busy search. A draft appointment creates a BusySearchResult object when the StartBusySearch method is called. This BusySearchResult object persists until a new search starts or until the appointment is no longer a draft because it is sent or canceled.
The following table lists properties along with their access and descriptions.
|
Property |
Access |
Description |
|---|---|---|
|
Application |
R/O |
Application. The Application object. |
|
BusySearchElements |
R/O |
BusySearchElements collection. Results (elements) for each recipient of the owning Appointment. Represents the partial status if Completed = FALSE, or the final result if Completed = TRUE. |
|
CombinedResult |
R/O |
BusySearchElement. A combined snapshot result for all recipients. A blank time block indicates all recipients are unscheduled. Represents a snapshot of partial results if Completed = FALSE, or the final results if Completed = TRUE. |
|
Completed |
R/O |
Boolean. TRUE if the search has finished. |
|
Parent |
R/O |
Appointment. Appointment object that owns this object. |
|
Range |
R/O |
Long. The number of days being searched. |
|
StartDate |
R/O |
Date. The date on which the search was started. |
Forces this BusySearchResult object to reread its property values from the message database. You can use this method to update the Completed property during a busy search. When a BusySearchResult object is refreshed, it recursively refreshes its BusySearchElements collection and the BusySearchElement object returned by its CombinedResult property
To perform a busy search:
Use Messages.Add in a folder to create a draft appointment.
Fill in appointment Recipients and StartDate.
Call StartBusySearch. A BusySearchResult object is created to contain the result.
Call Refresh to update the Completed property. When Completed is TRUE, the search is done and the BusySearchResult object contains the result.
Because the busy search can take some time, it executes asynchronously. While searching, the BusySearchResult object provides a snapshot of the partial results. The Completed property indicates when a search is finished.