nn::friends::CTR::UnscrambleLocalFriendCode Function

Syntax

Result UnscrambleLocalFriendCode(
     LocalFriendCode * pLocalFriendCodeList,
     const uds::CTR::ScrambledLocalFriendCode * pScrambledLocalFriendCodeList,
     size_t size = 1
);

Parameters

Name Description
out pLocalFriendCodeList Specifies a pointer to the buffer storing the decoded local friend code.
in pScrambledLocalFriendCodeList Specifies a pointer to a list of encoded local friend codes.
in size Specifies the number of buffer elements in the encoded local friend code 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

Decodes a friend's encoded local friend code.

When an encoded local friend code for someone who is not a friend is specified, an invalid local friend code is returned. The function still returns success in this case.

Revision History

2011/03/11
Added specific examples of return values.
2010/11/10
Initial version.

CONFIDENTIAL