nn::friends::CTR::GetFriendMii Function

Syntax

Result GetFriendMii(
     MiiData * pMiiDataList,
     const FriendKey * pFriendKeyList,
     size_t size = 1
);

Arguments

Name Description
out pMiiDataList Specifies a pointer to a buffer that stores obtained Mii data.
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
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 friends' Mii data.

Empty Mii data is returned in the given buffer if no friends correspond to the keys passed in as arguments. Even in this case, the function itself returns a value indicating success.

To use the acquired Mii data, the separate "Mii Library" is required.

Revision History

2011/03/11
Noted that this function returns a value indicating success even when it returns empty Mii data.
Revised some text under Description.
Added specific examples of return values.
2010/11/10
Initial version.

CONFIDENTIAL