Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method initiates a request to the Exchange server for free/busy data.
Syntax
HRESULT RequestFreeBusyData(
struct FreeBusyCriteria* pCriteria,
IExchangeClientRequest** ppiRequest
);
Parameters
- pCriteria
[in] Pointer to a FreeBusyCriteria instance that constrains the search to a specified alias and start time. Both alias and start time must be provided.
- ppiRequest
[out, retval] Pointer to a caller-supplied variable that this method uses to return a reference to an IExchangeClientRequest instance that represents this request.
Return Value
The following table shows possible return values:
| Value | Description |
|---|---|
E_POINTER |
The address of pCriteria does not point to a structure. |
E_INVALIDARG |
The pstStart element of the pCriteria parameter does not point to a valid SYSTEMTIME structure. |
E_OUTOFMEMORY |
Not enough memory was available to initiate the request. |
OWAEC_E_INVALIDSEARCH |
At least one field in the structure pointed to by pCriteria is NULL. Alias and start time must be specified. |
OWAEC_E_NOTINITIALIZED |
This instance of the Exchange client has not been initialized. It must be initialized using the IExchangeClient::Initialize method. |
S_OK |
The request was submitted successfully. |
Remarks
The results ultimately generated by this method contain the free/busy data that meets the specified criteria.
This method returns immediately.
When the IExchangeClientRequestCallback::OnRequestProgress method indicates that the request is complete by returning the e_ecrsSucceeded value, calling code can use the IExchangeClientRequest::GetDataItemArray method to retrieve the returned results.
Calling code can then call IExchangeClientDataItemArray::GetItemAt and then query the returned interface for the IExchangeClientFreeBusyInformation interface.
Finally, calling code can use the methods in the IExchangeClientFreeBusyInformation interface to retrieve free/busy information.
In some organizations, not all Outlook Web Access (OWA) servers contain free/busy information. For example, in organizations that use server clustering only the externally accessible servers might contain free/busy data; internal servers might not.
To retrieve free/busy data using a search initiated with this method you must use a server that contains free/busy data.
For a complete list of steps necessary to retrieve information using this method, see Retrieving Information from an Exchange Server.
Requirements
| Header | iexchangeclient.h, iexchangeclient.idl |
| Library | OWAExchangeClient.lib |
| Windows Embedded CE | Windows CE 5.0 and later |
See Also
Reference
IExchangeClient
ExchangeClientRequestStatus
FreeBusyCriteria
IExchangeClientDataItemArray::GetItemAt
IExchangeClientFreeBusyInformation
IExchangeClientRequest
IExchangeClientRequest::GetDataItemArray
IExchangeClientRequestCallback::OnRequestProgress