Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ContactsSearchEventArgs Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides data for the SearchCompleted event.

System.Object
  System.EventArgs
    Microsoft.Phone.UserData.ContactsSearchEventArgs

Namespace:  Microsoft.Phone.UserData
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)

public sealed class ContactsSearchEventArgs : EventArgs

The ContactsSearchEventArgs type exposes the following members.

  NameDescription
Public propertyFilterGets the filter that was used for a search.
Public propertyFilterKindGets the kind of filter that was used for the search.
Public propertyResultsGets the results of a search for contacts.
Public propertyStateGets a user-defined object that contains information about the operation.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Instances of this class are passed to the SearchCompleted event when a search for contacts started by the SearchAsync method completes.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_CONTACTS

Windows Phone 8

ID_CAP_APPOINTMENTS

Windows Phone 8

For more info, see App capabilities and hardware requirements for Windows Phone 8.

The following example assumes that you have a Windows Phone application that has a page with a databound list box named ContactResultsData. For the full example, including the XAML, see How to access contact data for Windows Phone 8.

void Contacts_SearchCompleted(object sender, ContactsSearchEventArgs e)
{
    MessageBox.Show(e.State.ToString());
    MessageBox.Show(e.FilterKind.ToString());
    MessageBox.Show(e.Filter.ToString());

    try
    {
        //Bind the results to the list box that displays them in the UI.
        ContactResultsData.DataContext = e.Results;
    }
    catch (System.Exception)
    {
        //That's okay, no results.
    }
}

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show: