Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
Represents the parameters when downloading community data. More...
#include <CTR_SDK/include/nn/olv/olv_TypesDownloadCommunityData.h>
Public Types | |
enum | Flags { FLAG_NONE = 0, FLAG_FILTER_BY_FAVORITE = (1<<0), FLAG_FILTER_BY_OFFICIAL = (1<<1), FLAG_FILTER_BY_SELF = (1<<2), FLAG_WITH_MII_DATA = (1<<3), FLAG_WITH_ICON_DATA = (1<<4) } |
Flags that can be specified in the SetFlags function. More... | |
Public Member Functions | |
DownloadCommunityDataListParam () | |
Instantiates the object. | |
u32 | GetWorkSize () const |
Gets the size of the working buffer used by the nn::olv::DownloadCommunityDataList function. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
void | SetCommunityDataMaxNum (u32 communityDataMaxNum) |
Sets the maximum number of communities to download. More... | |
void | SetCommunityId (u32 communityId, u8 index) |
Sets the community ID. More... | |
void | SetFlags (u32 flags) |
Sets flags. More... | |
void | SetWork (u8 *work, u32 workSize) |
Sets the size of the working buffer used by the nn::olv::DownloadCommunityDataList function. More... | |
Represents the parameters when downloading community data.
enum Flags |
Flags that can be specified in the SetFlags
function.
SetCommunityId
function, make sure that you specify one of the following: FLAG_FILTER_BY_FAVORITE
, FLAG_FILTER_BY_OFFICIAL
, or FLAG_FILTER_BY_SELF
. SetCommunityId
function is used to specify a community ID, you cannot specify FLAG_FILTER_BY_*
. u32 GetWorkSize | ( | ) | const |
Gets the size of the working buffer used by the nn::olv::DownloadCommunityDataList
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::DownloadCommunityDataList
function. void SetCommunityDataMaxNum | ( | u32 | communityDataMaxNum | ) |
Sets the maximum number of communities to download.
You must specify this option.
[in] | communityDataMaxNum | The maximum number of communities to download. Make sure that you specify a value of 1 or greater. If you have specified community IDs with the SetCommunityId function, make sure that you specify the number of communities beyond the ones specified to download. Make sure that you specify a value equal to or greater than this maximum value for the number of arrays in the communityDataList argument to the nn::olv::DownloadCommunityDataList function. |
void SetCommunityId | ( | u32 | communityId, |
u8 | index | ||
) |
Sets the community ID.
Specifying this option is not required.
If you specify a community ID, only the community with the specified ID is downloaded.
Up to a maximum of nn::olv::COMMUNITY_ID_MAX_NUM
community IDs can be specified.
[in] | communityId | The community ID. |
[in] | index | The index. The range of values that can be specified is from 0 to nn::olv::COMMUNITY_ID_MAX_NUM - 1 . |
void SetFlags | ( | u32 | flags | ) |
Sets flags.
You must specify this option when the SetCommunityId
function is not used.
[in] | flags | Flags (FLAG_* ). |
void SetWork | ( | u8 * | work, |
u32 | workSize | ||
) |
Sets the size of the working buffer used by the nn::olv::DownloadCommunityDataList
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. |