nn::friends::CTR::GetFriendPresence Function

Syntax

Result GetFriendPresence(
     FriendPresence * pFriendPresenceList,
     const PrincipalId * pPrincipalIdList,
     size_t size = 1
);

Arguments

Name Description
out pFriendPresenceList Specifies a pointer to a buffer storing obtained friend presence 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 friend presence information.

Cannot acquire the invitation flag and game mode of a friend who has a different matchmaking game ID specified.

Returns an empty presence in this buffer if there is no friend corresponding to the key passed in the arguments. The function still returns success in this case.

Revision History

2011/03/11
Noted that the function still returns successfully even if an empty presence is returned.
Revised a part of text in Description.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL