nn::friends::CTR::GetFriendProfile Function

Syntax

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

Arguments

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
ResultSuccess Process succeeded.
ResultInvalidPointer An invalid pointer was passed in as an argument.
ResultTooLarge The size argument was too large.
ResultNotInitialized The friend presence library has not been initialized.
Other Some other result may be returned as a result of factors such as the daemon's internal state.

Description

Gets a list of friends' profile information.

Empty profile information is returned in the given buffer if no friends correspond to the keys passed in as arguments. Empty profile information may also be returned if the friend has never disclosed being in the online state. But even in this case, the function itself returns a value indicating success.

For empty profile information, the platform code is invariably 0. As for data such as the region code, you cannot distinguish valid values from that information itself, so be sure to determine the platform code.

Revision History

2011/03/30
Clarified that empty profile information may also be returned if a given friend has never disclosed being in the online state.
Added text about the method of determining empty profile information.
2011/03/11
Noted that this function returns a value indicating success even when it returns empty profile information.
Revised some text under Description.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL