DWC_CheckFriendKey

Syntax

#include <dwc.h> 
BOOL DWC_CheckFriendKey(const DWCUserData *userdata,
                        u64 friend_key);

Arguments

userdata Pointer to the DWCUserData structure where the user data is stored.
friend_key Friend registration key

Return Values

TRUE Valid.
FALSE Invalid.

Description

Checks the validity of the friend registration key specified by friend_key. When adding a friend registration key to the friend roster, use the DWC_CreateFriendKeyToken function to create friend information based on that friend registration key.

Either prompt the user to reenter information if they enter an invalid key or display an input error.

Note: Starting from NITRO-DWC 3.0, the DWC_CreateFriendKey function employs a different method to generate the value used to check the validity of friend registration keys. Because of this change, the friend registration keys created with older versions of NITRO-DWC are no longer compatible. If for some special reason you need to handle these legacy friend registration keys, use the DWC_CreateFriendKeyLegacy and DWC_CheckFriendKeyLegacy functions.

See Also

DWC_CreateUserData DWC_CreateFriendKey DWC_GetFriendKey DWC_CheckFriendKeyLegacy

Revision History

For the change log prior to 5.1 PR2, click here.   


CONFIDENTIAL