nn::friends::CTR::GetFriendPresence Function

Syntax

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

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

List of Overloaded Member Functions

GetFriendPresence(FriendPresence *, const FriendKey *, size_t) Gets a list of friend presence information.
GetFriendPresence(FriendPresence *, const PrincipalId *, size_t) Gets a list of friend presence information.

Description of GetFriendPresence(FriendPresence *, const FriendKey *, size_t)

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. In this case the function still returns success.

The function retrieves an empty presence when a non-existent friend is specified. This is represented by an instance of the nn::friends::CTR::FriendPresence structure with isValid set to false. If the friend is offline, or has made the online status private, then the obtained presence will have isValid set to true, but isOnline will be false, and the gameMode structure will be zero-filled.

Description of GetFriendPresence(FriendPresence *, const PrincipalId *, size_t)

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. In this case the function still returns success.

The function retrieves an empty presence when a non-existent friend is specified. This is represented by a nn::friends::CTR::FriendPresence structure that has isValid set to false. If the friend is offline, or has made the online status private, then the obtained presence will have isValid set to true, but isOnline will be false, and the gameMode structure will be zero-filled.

CONFIDENTIAL