IMessengerContact::FriendlyName Property

Deprecated. Retrieves the friendly name of the contact associated with this MessengerContact object.

Syntax

HRESULT IMessengerContact::get_FriendlyName(BSTR *pbstrFriendlyName);

Parameters

  • pbstrFriendlyName
    Pointer to a BSTR that contains the friendly name of this user.

Return Value

Returns one of the following values: 

S_OK Success.
E_FAIL pbstrFriendlyName returned a NULL string.
E_OUTOFMEMORY Error returned by VARIANT handling library.
RPC_X_NULL_REF_POINTER pbstrFriendlyName was a NULL pointer.

Remarks

The friendly name is used in conjunction with the sign-in name primarily for user interface (UI) display. Because a friendly name is not guaranteed to be unique, it is good practice to display both the sign-in and friendly names for any contact viewed within a client.

Note  This property is available for scripting languages only in a trusted zone.

Important  IMessengerContact::FriendlyName is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

IMessengerContact::SigninName, DMessengerEvents::OnContactFriendlyNameChange