nn::friends::CTR::GetFriendKeyList Function

Syntax

Result GetFriendKeyList(
     FriendKey * pFriendKeyList,
     size_t * pNum,
     size_t offset = 0,
     size_t size = FRIEND_LIST_SIZE
);

Arguments

Name Description
out pFriendKeyList Specifies a pointer to a buffer that stores obtained friend keys.
out pNum Specifies a pointer to a buffer that stores the number actually obtained.
in offset Specifies the index of the friend key to begin obtaining.
in size Specifies the maximum number of friend keys to obtain (the number of buffer elements).

Return Values

Returns the result of the operation.

Description

Gets a list of the friend keys registered in the friend list.

The obtained friend keys also include peers who have not yet established a friend relationship with the local host.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL