DWC_CheckFriendKey

Syntax

#include <dwc.h>

BOOL DWC_CheckFriendKey(const DWCUserData *userdata,
                        u64 friend_key);

Arguments

userdata	Pointer to the `DWCUserData` structure that stores user data.
friend_key	Friend code.

Return Values

TRUE	Valid.
FALSE	Invalid.

Description

Checks the validity of the friend code specified by friend_key. When adding a friend code to the friend roster, use DWC_CreateFriendKeyToken to create friend data based on that friend code.

If the user enters an invalid code, either prompt the user to re-enter the information, or display an input error.

In RVLDWC1.4.15, the algorithm for generating friend codes was changed. Note that there is no compatibility with friend codes generated using previous versions. To check the validity of friend codes generated using previous versions, use the DWC_CheckFriendKeyLegacy function.

Revision History

1.4.15: Added a precaution to reflect modification of the creation algorithm.