Nintendo 3DS Miiverse Library  1.3.2
(OLV/Olive)
UploadEmpathyToPostDataParam Class Reference

The class representing the parameters used when uploading a Yeah to a post or removing a Yeah. More...

#include <CTR_SDK/include/nn/olv/olv_TypesUploadEmpathyToPostData.h>

Public Types

enum  {
  FLAG_NONE = 0,
  FLAG_REMOVE = (1<<0)
}
 Flags that can be specified in the SetFlags function. More...
 

Public Member Functions

 UploadEmpathyToPostDataParam ()
 Instantiates the object.
 
u32 GetWorkSize () const
 Gets the size of the working buffer used by the nn::olv::UploadEmpathyToPostData function. More...
 
void Reset ()
 Reverts parameters to their initial state.
 
void SetFlags (u32 flags)
 Sets flags. More...
 
void SetPostId (const char *postId)
 Sets the post ID. More...
 
void SetWork (u8 *work, u32 workSize)
 Sets the size of the working buffer used by the nn::olv::UploadEmpathyToPostData function. More...
 

Detailed Description

The class representing the parameters used when uploading a Yeah to a post or removing a Yeah.

Member Enumeration Documentation

anonymous enum

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 Yeah.

Member Function Documentation

u32 GetWorkSize ( ) const

Gets the size of the working buffer used by the nn::olv::UploadEmpathyToPostData 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.

Returns
Returns the size of the working buffer used by the nn::olv::UploadEmpathyToPostData function.
void SetFlags ( u32  flags)

Sets flags.

Specifying this option is not required.

Parameters
[in]flagsFlags (FLAG_*).
void SetPostId ( const char *  postId)

Sets the post ID.

You must specify this option.

Parameters
[in]postIdThe post ID.
The maximum number of characters that can be specified is nn::olv::POST_ID_BUFF_LENGTH - 1.
void SetWork ( u8 *  work,
u32  workSize 
)

Sets the size of the working buffer used by the nn::olv::UploadEmpathyToPostData function.

You must specify this option.
Specify a buffer of at least the size obtained with the GetWorkSize function.

Parameters
[in]workThe working buffer.
[in]workSizeThe size of the working buffer.

The documentation for this class was generated from the following file: