nn::friends::CTR::GetFriendPresence Function

Syntax

Result GetFriendPresence(
     FriendPresence * pFriendPresenceList,
     const FriendKey * pFriendKeyList,
     size_t size = 1
);

Arguments

Name Description
out pFriendPresenceList Specifies a pointer to a buffer storing obtained friend presence information.
in pFriendKeyList Specifies a pointer to a list of friend keys.
in size Specifies the number of buffer elements in the friend key 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 friend presence information.

You cannot get the invitation flag and game mode of a friend who has a different matchmaking game ID specified.

Empty presence information is returned in the given buffer if no friends correspond to the keys passed in as arguments. Even in this case, the function itself returns a value indicating success.

Revision History

2011/03/11
Noted that this function returns a value indicating success even when it returns empty presence information.
Revised some text under Description.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL