Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
Represents the parameters when starting the Miiverse application. More...
#include <CTR_SDK/include/nn/olv/olv_TypesStartPortalApp.h>
Public Types | |
enum | { COMMON_DATA_MAX_NUM = 256 } |
Constant. More... | |
enum | { MODE_NONE = 0, MODE_START_COMMUNITY = MODE_VALUE_START_COMMUNITY, MODE_START_POST = MODE_VALUE_START_POST, MODE_START_USER = MODE_VALUE_START_USER } |
Modes that can be specified in the SetMode function. More... | |
enum | { FLAG_NONE = 0 } |
Flags that can be specified in the SetFlags function. More... | |
Public Member Functions | |
StartPortalAppParam () | |
Instantiates the object. | |
u32 | GetWorkSize () const |
Gets the size of the working buffer used by the nn::olv::StartPortalApp function. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
void | SetCommonData (u32 type, const u8 *data, u32 dataSize) |
Adds common data. More... | |
void | SetCommunityId (u32 communityId) |
Sets the community ID. More... | |
void | SetFlags (u32 flags) |
Sets flags. More... | |
void | SetMode (u32 mode) |
Sets the mode. More... | |
void | SetPostId (const char *postId) |
Sets the post ID. More... | |
void | SetTopicTag (const wchar_t *topicTag) |
Sets the topic tag. More... | |
void | SetUserPid (u32 userPid) |
Sets the principal ID. More... | |
void | SetWork (u8 *work, u32 workSize) |
Sets the size of the working buffer used by the nn::olv::StartPortalApp function. More... | |
Represents the parameters when starting the Miiverse application.
anonymous enum |
anonymous enum |
anonymous enum |
Flags that can be specified in the SetFlags
function.
Enumerator | |
---|---|
FLAG_NONE |
This is the state when no flags are specified. |
u32 GetWorkSize | ( | ) | const |
Gets the size of the working buffer used by the nn::olv::StartPortalApp
function.
Call this function after all of the various parameters have been specified, with the exception of the SetWork
function.
void SetCommonData | ( | u32 | type, |
const u8 * | data, | ||
u32 | dataSize | ||
) |
Adds common data.
Specifying this option is not required.
Under normal use conditions this specification is not required.
The maximum amount that can be added is nn::olv::StartPortalAppParam::COMMON_DATA_MAX_NUM
.
Note that the only value stored is the address, so the data must remain valid until the call to the nn::olv::StartPortalApp
function ends.
[in] | type | The type of the common data (COMMON_DATA_TYPE_*). |
[in] | data | The common data. |
[in] | dataSize | The size of the common data. |
void SetCommunityId | ( | u32 | communityId | ) |
Sets the community ID.
You can specify this option when MODE_START_COMMUNITY
is specified for the SetMode
function. If not specified, the general community is shown by default.
[in] | communityId | The community ID. |
void SetFlags | ( | u32 | flags | ) |
Sets flags.
This is for future expansion. It is not used currently.
[in] | flags | Flags (FLAG_* ). |
void SetMode | ( | u32 | mode | ) |
Sets the mode.
Specifying this option is not required.
[in] | mode | The mode (MODE_* ). |
void SetPostId | ( | const char * | postId | ) |
Sets the post ID.
You must specify this option when MODE_START_POST
is specified for the SetMode
function.
Note that the only value stored is the address, so the data must remain valid until the call to the nn::olv::StartPortalApp
function ends.
[in] | postId | The post ID. The maximum number of characters that can be specified is nn::olv::POST_ID_BUFF_LENGTH - 1 . |
void SetTopicTag | ( | const wchar_t * | topicTag | ) |
Sets the topic tag.
Specifying this option is not required.
You can only specify this option when MODE_START_COMMUNITY
is specified for the SetMode
function.
When specified, only posts with the specified topic tag are shown.
Note that the only value stored is the address, so the data must remain valid until the call to the nn::olv::StartPortalApp
function ends.
[in] | topicTag | The topic tag. Use UTF-16LE for the encoding. The maximum number of characters that can be specified is nn::olv::TOPIC_TAG_MAX_LENGTH . |
void SetUserPid | ( | u32 | userPid | ) |
Sets the principal ID.
You must specify this option when MODE_START_USER
is specified for the SetMode
function.
[in] | userPid | The principal ID. |
void SetWork | ( | u8 * | work, |
u32 | workSize | ||
) |
Sets the size of the working buffer used by the nn::olv::StartPortalApp
function.
You must specify this option.
Specify a buffer of at least the size obtained with the GetWorkSize
function.
Device memory cannot be specified for this buffer.
This buffer cannot be destroyed at the point the call to the nn::olv::StartPortalApp
function finishes. See the description of the nn::olv::StartPortalApp
function.
[in] | work | The working buffer. |
[in] | workSize | The size of the working buffer. |