nn::friends::CTR::GetFriendAttributeFlags Function

Syntax

Result GetFriendAttributeFlags(
     bit32 * pAttributeFlagsList,
     const PrincipalId * pPrincipalIdList,
     size_t size = 1
);

Arguments

Name Description
out pAttributeFlagsList Specifies a pointer to the buffer that stores obtained relationship 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 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 this function returns a value indicating success even when it returns an invalid local friend code.
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL