nn::friends::CTR::UnscrambleLocalFriendCode Function

Syntax

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

Arguments

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

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. Even in this case, the function itself returns a value indicating success.

Revision History

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

CONFIDENTIAL