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

The class representing the parameters used when following users and canceling the following of users. More...

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

Public Types

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

Public Member Functions

 UploadFollowToUserDataParam ()
 Instantiates the object.
 
u32 GetWorkSize () const
 Gets the size of the working buffer to use with the nn::olv::UploadFollowToUserData function. More...
 
void Reset ()
 Reverts parameters to their initial state.
 
void SetFlags (u32 flags)
 Sets flags. More...
 
void SetUserPid (u32 userPid)
 Sets the principal ID. More...
 
void SetWork (u8 *work, u32 workSize)
 Specifies the working buffer to use with the nn::olv::UploadFollowToUserData function. More...
 

Detailed Description

The class representing the parameters used when following users and canceling the following of users.

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 canceling the following of users.

Member Function Documentation

u32 GetWorkSize ( ) const

Gets the size of the working buffer to use with the nn::olv::UploadFollowToUserData function.

Call this function after all of the various parameters have been specified, with the exception of the SetWork function.

Returns
Returns the size of the working buffer to use with the nn::olv::UploadFollowToUserData function.
void SetFlags ( u32  flags)

Sets flags.

Specifying this option is not required.

Parameters
[in]flagsFlags (FLAG_*).
void SetUserPid ( u32  userPid)

Sets the principal ID.

You must specify this option.

Parameters
[in]userPidThe principal ID.
void SetWork ( u8 *  work,
u32  workSize 
)

Specifies the working buffer to use with the nn::olv::UploadFollowToUserData 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: