nn::friends::CTR::GetFriendMii Function

Syntax

Result GetFriendMii(
     MiiData * pMiiDataList,
     const PrincipalId * pPrincipalIdList,
     size_t size = 1
);

Arguments

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

Returns empty Mii data in this buffer if there is no friend corresponding to the key passed in the arguments. In this case the function still returns success.

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

Revision History

2011/03/11
Noted that the function will still return success even if an empty Mii is returned.
Revised text in Description.
Added specific examples of return values.
2010/11/10
Initial version.

CONFIDENTIAL