Nintendo 3DS Miiverse Library
1.3.2
(OLV/Olive)
|
The class representing the parameters used when creating, updating, and deleting community data. More...
#include <CTR_SDK/include/nn/olv/olv_TypesUploadCommunityData.h>
Public Types | |
enum | { FLAG_NONE = 0, FLAG_DELETE = UPLOAD_FLAG_VALUE_DELETE } |
Flags that can be specified in the SetFlags function. More... | |
Public Member Functions | |
UploadCommunityDataParam () | |
Instantiates the object. | |
u32 | GetWorkSize () const |
Gets the size of the working buffer used by the nn::olv::UploadCommunityData function. More... | |
void | Reset () |
Reverts parameters to their initial state. | |
void | SetAppData (const u8 *appData, u32 appDataSize) |
Sets the application data. More... | |
void | SetCommentTextMaxLength (u32 length) |
Specifies the maximum number of characters for comments that can be posted from the Miiverse application. More... | |
void | SetCommunityId (u32 communityId) |
Sets the community ID. More... | |
void | SetDescriptionText (const wchar_t *descriptionText) |
Sets the community description. More... | |
void | SetFlags (u32 flags) |
Sets flags. More... | |
void | SetIconData (const u8 *iconData, u32 iconDataSize) |
Sets the icon data. More... | |
void | SetPostTextMaxLength (u32 length) |
Specifies the maximum number of characters that can be posted from the Miiverse application. More... | |
void | SetTitleText (const wchar_t *titleText) |
Sets the community name. More... | |
void | SetWork (u8 *work, u32 workSize) |
Sets the size of the working buffer used by the nn::olv::UploadCommunityData function. More... | |
The class representing the parameters used when creating, updating, and deleting community data.
anonymous enum |
Flags that can be specified in the SetFlags
function.
Enumerator | |
---|---|
FLAG_NONE |
This is the state when no flags are specified. |
FLAG_DELETE |
Specify this flag when deleting community data. |
u32 GetWorkSize | ( | ) | const |
Gets the size of the working buffer used by the nn::olv::UploadCommunityData
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::UploadCommunityData
function. void SetAppData | ( | const u8 * | appData, |
u32 | appDataSize | ||
) |
Sets the application data.
Specifying this option is not required.
[in] | appData | The application data. Note that only the address value is stored, so this data must be valid until the call to the nn::olv::UploadCommunityData function ends. |
[in] | appDataSize | The size of the application data. The maximum value that can be specified is nn::olv::APP_DATA_BUFF_LENGTH . |
void SetCommentTextMaxLength | ( | u32 | length | ) |
Specifies the maximum number of characters for comments that can be posted from the Miiverse application.
Specifying this option is not required.
If nothing is specified, 100 characters is set as the default.
[in] | length | The maximum number of characters for comments posted from the Miiverse application. The maximum number of characters that can be specified is nn::olv::BODY_TEXT_MAX_LENGTH . |
void SetCommunityId | ( | u32 | communityId | ) |
Sets the community ID.
You must specify this option when updating or deleting community data. If not specified, new community data is created by default.
[in] | communityId | The community ID. |
void SetDescriptionText | ( | const wchar_t * | descriptionText | ) |
Sets the community description.
Specifying this option is not required.
[in] | descriptionText | The community description. Use UTF-16LE for the encoding. The maximum number of characters that can be specified is nn::olv::DESCRIPTION_TEXT_BUFF_LENGTH - 1 . |
void SetFlags | ( | u32 | flags | ) |
Sets flags.
[in] | flags | Flags (FLAG_* ). |
void SetIconData | ( | const u8 * | iconData, |
u32 | iconDataSize | ||
) |
Sets the icon data.
Specifying this option is not required.
[in] | iconData | The icon data. Note that only the address value is stored, so this data must be valid until the call to the nn::olv::UploadCommunityData function ends. |
[in] | iconDataSize | The size of the icon data. The maximum value that can be specified is nn::olv::ICON_DATA_BUFF_LENGTH . |
void SetPostTextMaxLength | ( | u32 | length | ) |
Specifies the maximum number of characters that can be posted from the Miiverse application.
Specifying this option is not required.
If nothing is specified, 100 characters is set as the default.
[in] | length | The maximum number of characters that can be posted from the Miiverse application. The maximum number of characters that can be specified is nn::olv::BODY_TEXT_MAX_LENGTH . |
void SetTitleText | ( | const wchar_t * | titleText | ) |
Sets the community name.
You must specify this option when creating new community data.
[in] | titleText | The community name. Use UTF-16LE for the encoding. The maximum number of characters that can be specified is nn::olv::TITLE_TEXT_BUFF_LENGTH - 1 . |
void SetWork | ( | u8 * | work, |
u32 | workSize | ||
) |
Sets the size of the working buffer used by the nn::olv::UploadCommunityData
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. |