`nn::friends::CTR::GetFriendKeyList` Function

Syntax

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

	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).

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.

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.

CONFIDENTIAL