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

A class that stores the connection results. More...

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

Public Member Functions

 ConnectedData ()
 Instantiates the object.
 
void GetHostName (char *hostName, u32 hostNameMaxLength) const
 Gets the hostname. More...
 
void Reset ()
 Reverts parameters to their initial state.
 
bool TestFlags (u32 flags) const
 Tests flags. More...
 

Detailed Description

A class that stores the connection results.

Member Function Documentation

void GetHostName ( char *  hostName,
u32  hostNameMaxLength 
) const

Gets the hostname.

Note that specifying invalid arguments for this function, such as the following, results in an assert in debug/development versions and the function returning without doing anything in release versions.

  • If NULL is specified for the hostName argument.
  • If a value less than that of nn::olv::HOST_NAME_BUFF_LENGTH is specified for the hostNameMaxLength argument.
Parameters
[out]hostNameThe buffer that stores the hostname.
[in]hostNameMaxLengthThe length of the buffer that stores the hostname, including the terminating null character.
Make sure that you specify a size of at least nn::olv::HOST_NAME_BUFF_LENGTH.
bool TestFlags ( u32  flags) const

Tests flags.

This is for future expansion. It is not used currently.

Parameters
[in]flagsFlags (FLAG_*).
Returns
Returns true if any of the flags are set; returns false otherwise.

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