nn::friends::CTR::GetFriendAttributeFlags Function

Syntax

Result GetFriendAttributeFlags(
     bit32 * pAttributeFlagsList,
     const FriendKey * pFriendKeyList,
     size_t size = 1
);

Arguments

Name Description
out pAttributeFlagsList Specifies a pointer to the buffer that stores obtained relationship 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
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 relationships.

Friend relationships are represented as a bitwise OR of attributes. Friends that have established a friend relationship with the local host at least once have the nn::friends::CTR::ATTRIBUTE_FLAG_ESTABLISHED bit set to 1.

Revision History

2011/03/11
Noted that the function will still return success even if an invalid local friend code returned.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL