Contacts::GetContact

The Contacts::GetContact function returns a Contact object based on its email address.

Syntax

[object] GetContact(
    [string] Email
);

Parameters

Email

[string] The email of the user. Character case doesn't matter.

Return Value

A Contact object if the contact is found in the object's list, null otherwise.

This function typically fails for the following reason:

• The Contacts object was generated by a different active user than the one currently signed-in (when the object refers to the entire user's contact list).

Remarks

By default, this function searches for both Windows Live and Yahoo Messenger contacts. If the current user has twice the same contact in its list, both using the same sign-in email for Windows Live and Yahoo, the contact object returned by default will always be the one connected on Windows Live. You can force a request for contacts on the Yahoo network by prefixing the email with "yahoo:".

Function Information

See Also

Contacts Object, Contact Object, Contact::Network.