Share via

IExchangeClient::RequestContacts (Windows Embedded CE 6.0)

  • Article

1/6/2010

This method initiates a request to the Exchange server for contact information.

Syntax

HRESULT RequestContacts(
  struct ContactsSearchCriteria* pCriteria,
  IExchangeClientRequest** ppiRequest
);

Parameters

  • pCriteria
    [in] Pointer to a ContactsSearchCriteria instance that constrains the contacts returned by this request.
  • 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_OUTOFMEMORY

Not enough memory was available to initiate the request.

OWAEC_E_NOTINITIALIZED

This instance of the Exchange client has not yet been initialized.

It must be initialized using the IExchangeClient::Initialize method.

S_OK

The request was submitted successfully.

Remarks

The results generated by this method contain all of the contacts for the current user, constrained by optional criteria specified in the pCriteria parameter. For more information about how the Exchange server responds to different criteria values, see ContactsSearchCriteria.

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 IExchangeClientContactInformation interface.

Finally, calling code can use the methods in the IExchangeClientContactInformation interface to retrieve contact information.

For a 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
ContactsSearchCriteria
ExchangeClientRequestStatus
IExchangeClientDataItemArray::GetItemAt
IExchangeClientContactInformation
IExchangeClientRequest
IExchangeClientRequest::GetDataItemArray
IExchangeClientRequestCallback::OnRequestProgress