DWC_CheckFriendKeyLegacy

Syntax

#include <dwc.h> 
BOOL DWC_CheckFriendKeyLegacy(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: This function remains in order to preserve compatibility with friend registration keys generated by NITRO-DWC versions prior to NITRO-DWC 3.0. Unless it is necessary to use the legacy functions, use the DWC_CreateFriendKey and DWC_CheckFriendKey functions.

See Also

DWC_CreateUserData DWC_CreateFriendKey DWC_GetFriendKey DWC_CheckFriendKey

Revision History

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


CONFIDENTIAL