nn::friends::CTR::GetFriendProfile Function

Syntax

Result GetFriendProfile(
     Profile * pProfileList,
     const PrincipalId * pPrincipalIdList,
     size_t size = 1
);

Parameters

Name Description
out pProfileList Specifies a pointer to a buffer storing obtained profile information.
in pPrincipalIdList Specifies a pointer to a list of principal IDs.
in size Specifies the number of buffer elements in the principal ID list.

Return Values

Returns the result of the operation.

Value Description
Result::IsSuccess Process succeeded.
ResultInvalidPointer Invalid pointer passed as argument.
ResultTooLarge The value passed as the argument is too large.
ResultNotInitialized The friend presence library is not initialized.
Other Another result may be returned, depending on the internal state of the daemon and other factors.

Description

Gets a list of friends' profile information.

Returns empty profile information in this buffer if there is no friend corresponding to the key passed in the arguments. The function will also return empty profile information if the peer has never published its online status. The function itself will still return success in this case.

The platform code of empty profile information is always 0. If you cannot tell if a value by itself is valid (for example, a region code), always use the platform code to determine validity.

Revision History

2011/03/30
Added note that empty profile information may also be returned if the friend has never published its online status.
Added method for determining if profile information is empty.

2011/03/11
Noted that the function will still return success even if empty profile information is returned.
Fixed typos in description.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL