Share via


IExchangeClientFreeBusyInformation::GetFreeBusyData (Windows Embedded CE 6.0)

1/6/2010

This method provides the free/busy data associated with the free/busy data entry.

Syntax

HRESULT GetFreeBusyData(
  WCHAR* wszDataBuffer,
  UINT cchDataBuffer
);

Parameters

  • wszDataBuffer
    [out] Pointer to a caller-allocated buffer that this method uses to store the free/busy data.
  • cchDataBuffer
    [in] The size of the buffer represented by the pointer in the wszDataBuffer parameter.

Return Value

The following table shows possible return values:

Value Description

E_POINTER

The address in wszDataBuffer is not valid.

E_INVALIDARG

The size of the provided buffer, according to cchDataBuffer, was 0.

S_OK

The free/busy data was provided successfully.

Remarks

The free/busy data returned in the wszDataBuffer parameter is a string that looks similar to this:

0000111100002222

Each numeral represents the free/busy status for a particular interval of time. The numbers used in the return data are as follows:

  • 0 - Free
  • 1 - Busy
  • 2 - Tentative
  • 3 - Out of office
  • 4 - Data not available

To set the time when the returned free/busy data starts, use the FreeBusyCriteria instance you pass to IExchangeClient::RequestFreeBusyData.

To control the amount and granularity of data returned, use the FBSSearchLength and FBSInterval registry settings documented in Exchange Client Registry Settings.

For more information about free/busy information returned by Outlook Web Access (OWA) servers, search for article 813268 at this Microsoft web site.

In some organizations, not all 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.

Requirements

Header iexchangeclient.h, iexchangeclient.idl
Library OWAExchangeClient.lib
Windows Embedded CE Windows CE 5.0 and later

See Also

Reference

IExchangeClientFreeBusyInformation