Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
The class representing the parameters used when registering a favorite to a community or removing a favorite. More...
#include <CTR_SDK/include/nn/olv/olv_TypesUploadFavoriteToCommunityData.h>
Public Types | |
enum | Flags { FLAG_NONE = 0, FLAG_REMOVE = (1<<0) } |
Flags that can be specified in the SetFlags function. More... | |
Public Member Functions | |
UploadFavoriteToCommunityDataParam () | |
Instantiates the object. | |
u32 | GetWorkSize () const |
Gets the size of the working buffer used by the nn::olv::UploadFavoriteToCommunityData function. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
void | SetCommunityCode (const char *communityCode) |
Sets the community code. More... | |
void | SetCommunityId (u32 communityId) |
Sets the community ID. More... | |
void | SetFlags (u32 flags) |
Sets flags. More... | |
void | SetWork (u8 *work, u32 workSize) |
Sets the working buffer used by the nn::olv::UploadFavoriteToCommunityData function. More... | |
The class representing the parameters used when registering a favorite to a community or removing a favorite.
enum Flags |
Flags that can be specified in the SetFlags
function.
Enumerator | |
---|---|
FLAG_NONE |
This is the state when no flags are specified. |
FLAG_REMOVE |
Specify this flag when removing a favorite. |
u32 GetWorkSize | ( | ) | const |
Gets the size of the working buffer used by the nn::olv::UploadFavoriteToCommunityData
function.
Call this function after all of the various parameters have been specified, with the exception of the SetWork
function.
This function returns fixed values.
nn::olv::UploadFavoriteToCommunityData
function. void SetCommunityCode | ( | const char * | communityCode | ) |
Sets the community code.
Specifying this option is not required. You are prohibited from specifying this option when a community ID is specified for the SetCommunityId
function.
If neither a community ID nor a community code is specified, the general community is registered or removed as a favorite by default.
[in] | communityCode | The community code. |
void SetCommunityId | ( | u32 | communityId | ) |
Sets the community ID.
Specifying this option is not required. You are prohibited from specifying this option when a community code is specified for the SetCommunityCode
function.
If neither a community ID nor a community code is specified, the general community is registered or removed as a favorite by default.
[in] | communityId | The community ID. |
void SetFlags | ( | u32 | flags | ) |
Sets flags.
Specifying this option is not required.
[in] | flags | Flags (FLAG_* ). |
void SetWork | ( | u8 * | work, |
u32 | workSize | ||
) |
Sets the working buffer used by the nn::olv::UploadFavoriteToCommunityData
function.
You must specify this option.
Specify a buffer of at least the size obtained with the GetWorkSize
function.
[in] | work | The working buffer. |
[in] | workSize | The size of the working buffer. |