Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
The class for storing the downloaded user data. More...
#include <CTR_SDK/include/nn/olv/olv_TypesDownloadUserData.h>
Public Types | |
enum | { FLAG_NONE = 0, FLAG_WITH_MII_DATA = DOWNLOAD_FLAG_VALUE_WITH_MII_DATA } |
Flags that can be specified in the TestFlags function. More... | |
Public Member Functions | |
DownloadedUserData () | |
Instantiates the object. | |
void | GetMiiData (nn::mii::StoreData *storeData) const |
Gets the Mii data of the user. More... | |
void | GetMiiNickname (wchar_t *miiNickname, u32 miiNicknameMaxLength) const |
Gets the nickname of the Mii of the user. More... | |
u32 | GetUserPid () const |
Gets the principal ID of the user. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
bool | TestFlags (u32 flags) const |
Tests flags. More... | |
The class for storing the downloaded user data.
anonymous enum |
Flags that can be specified in the TestFlags
function.
Enumerator | |
---|---|
FLAG_NONE |
This is the state when no flags are specified. |
FLAG_WITH_MII_DATA |
This flag indicates that the user data includes Mii data. |
void GetMiiData | ( | nn::mii::StoreData * | storeData | ) | const |
Gets the Mii data of the user.
This function can only be used when the return value from the TestFlags
function is true
when FLAG_WITH_MII_DATA
is specified.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
TestFlags
function with FLAG_WITH_MII_DATA
specified yields a return value of false
.NULL
is specified for the storeData argument.[out] | storeData | The buffer that stores the Mii data. |
void GetMiiNickname | ( | wchar_t * | miiNickname, |
u32 | miiNicknameMaxLength | ||
) | const |
Gets the nickname of the Mii of the user.
Note that if you call this function in one of the following invalid states, it will stop on an assertion in the debug/development versions, and return without doing anything in the release version.
NULL
is specified for the miiNickname argument.nn::olv::MII_NICKNAME_BUFF_LENGTH
is specified for the miiNicknameMaxLength argument.[out] | miiNickname | The buffer that stores the nickname of the Mii. |
[in] | miiNicknameMaxLength | The length of the buffer that stores the nickname of the Mii, including the terminating null character. Make sure that you specify a size of at least nn::olv::MII_NICKNAME_BUFF_LENGTH . |
u32 GetUserPid | ( | ) | const |
Gets the principal ID of the user.
bool TestFlags | ( | u32 | flags | ) | const |
Tests flags.
[in] | flags | Flags (FLAG_* ). |
true
if any of the flags are set; returns false
otherwise.