1184 lines
68 KiB
HTML
1184 lines
68 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/frd.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">frd.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Friend Services.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="mii_8h_source.html">3ds/mii.h</a>></code><br />
|
|
</div>
|
|
<p><a href="frd_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structFriendKey.html">FriendKey</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Friend key data. <a href="structFriendKey.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structTitleData.html">TitleData</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Friend Title data. <a href="structTitleData.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structFriendProfile.html">FriendProfile</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Friend profile data. <a href="structFriendProfile.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGameDescription.html">GameDescription</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Game Description structure. <a href="structGameDescription.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNotificationEvent.html">NotificationEvent</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Friend Notification Event structure. <a href="structNotificationEvent.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ad2feecb713f820cbcd168f19e4f55866"><td class="memItemLeft" align="right" valign="top"><a id="ad2feecb713f820cbcd168f19e4f55866"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ad2feecb713f820cbcd168f19e4f55866">FRIEND_SCREEN_NAME_SIZE</a>   0xB</td></tr>
|
|
<tr class="memdesc:ad2feecb713f820cbcd168f19e4f55866"><td class="mdescLeft"> </td><td class="mdescRight">11-byte UTF-16 screen name <br /></td></tr>
|
|
<tr class="separator:ad2feecb713f820cbcd168f19e4f55866"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac300c5a4b565eaaf656d7fc6a82dd10b"><td class="memItemLeft" align="right" valign="top"><a id="ac300c5a4b565eaaf656d7fc6a82dd10b"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ac300c5a4b565eaaf656d7fc6a82dd10b">FRIEND_COMMENT_SIZE</a>   0x21</td></tr>
|
|
<tr class="memdesc:ac300c5a4b565eaaf656d7fc6a82dd10b"><td class="mdescLeft"> </td><td class="mdescRight">33-byte UTF-16 comment <br /></td></tr>
|
|
<tr class="separator:ac300c5a4b565eaaf656d7fc6a82dd10b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4426da9cb91df71e799ca69d9ed40a4e"><td class="memItemLeft" align="right" valign="top"><a id="a4426da9cb91df71e799ca69d9ed40a4e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a4426da9cb91df71e799ca69d9ed40a4e">FRIEND_LIST_SIZE</a>   0x64</td></tr>
|
|
<tr class="memdesc:a4426da9cb91df71e799ca69d9ed40a4e"><td class="mdescLeft"> </td><td class="mdescRight">100 (Max number of friends) <br /></td></tr>
|
|
<tr class="separator:a4426da9cb91df71e799ca69d9ed40a4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a943bc52f706bd0462355f5dc74d210ce"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce">NotificationTypes</a> { <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad">USER_WENT_ONLINE</a> = 1
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99">USER_WENT_OFFLINE</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12">FRIEND_WENT_ONLINE</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d">FRIEND_UPDATED_PRESENCE</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc">FRIEND_UPDATED_MII</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902">FRIEND_UPDATED_PROFILE</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e">FRIEND_WENT_OFFLINE</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8">FRIEND_REGISTERED_USER</a>
|
|
, <br />
|
|
  <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35">FRIEND_SENT_INVITATION</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a943bc52f706bd0462355f5dc74d210ce"><td class="mdescLeft"> </td><td class="mdescRight">Enum to use with FRD_GetNotificationEvent. <a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce">More...</a><br /></td></tr>
|
|
<tr class="separator:a943bc52f706bd0462355f5dc74d210ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a8031a28577f6a422ed5d2fa5542bf46f"><td class="memItemLeft" align="right" valign="top"><a id="a8031a28577f6a422ed5d2fa5542bf46f"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a8031a28577f6a422ed5d2fa5542bf46f">frdInit</a> (void)</td></tr>
|
|
<tr class="memdesc:a8031a28577f6a422ed5d2fa5542bf46f"><td class="mdescLeft"> </td><td class="mdescRight">Initializes FRD service. <br /></td></tr>
|
|
<tr class="separator:a8031a28577f6a422ed5d2fa5542bf46f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ec99ca5562cfefeb51007695dd3ec1c"><td class="memItemLeft" align="right" valign="top"><a id="a5ec99ca5562cfefeb51007695dd3ec1c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a5ec99ca5562cfefeb51007695dd3ec1c">frdExit</a> (void)</td></tr>
|
|
<tr class="memdesc:a5ec99ca5562cfefeb51007695dd3ec1c"><td class="mdescLeft"> </td><td class="mdescRight">Exists FRD. <br /></td></tr>
|
|
<tr class="separator:a5ec99ca5562cfefeb51007695dd3ec1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc80cefa94c228b0231211912e074041"><td class="memItemLeft" align="right" valign="top"><a id="abc80cefa94c228b0231211912e074041"></a>
|
|
<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#abc80cefa94c228b0231211912e074041">frdGetSessionHandle</a> (void)</td></tr>
|
|
<tr class="memdesc:abc80cefa94c228b0231211912e074041"><td class="mdescLeft"> </td><td class="mdescRight">Get FRD handle. <br /></td></tr>
|
|
<tr class="separator:abc80cefa94c228b0231211912e074041"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1f34be91ea44f0d37c2756f65323975"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#aa1f34be91ea44f0d37c2756f65323975">FRDU_HasLoggedIn</a> (bool *state)</td></tr>
|
|
<tr class="memdesc:aa1f34be91ea44f0d37c2756f65323975"><td class="mdescLeft"> </td><td class="mdescRight">Gets the login status of the current user. <a href="frd_8h.html#aa1f34be91ea44f0d37c2756f65323975">More...</a><br /></td></tr>
|
|
<tr class="separator:aa1f34be91ea44f0d37c2756f65323975"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca6f294dad46e3355c891bbad9f681a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#aca6f294dad46e3355c891bbad9f681a0">FRDU_IsOnline</a> (bool *state)</td></tr>
|
|
<tr class="memdesc:aca6f294dad46e3355c891bbad9f681a0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the online status of the current user. <a href="frd_8h.html#aca6f294dad46e3355c891bbad9f681a0">More...</a><br /></td></tr>
|
|
<tr class="separator:aca6f294dad46e3355c891bbad9f681a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad285890ae24b20e4b1fbbf0016658388"><td class="memItemLeft" align="right" valign="top"><a id="ad285890ae24b20e4b1fbbf0016658388"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ad285890ae24b20e4b1fbbf0016658388">FRD_Logout</a> (void)</td></tr>
|
|
<tr class="memdesc:ad285890ae24b20e4b1fbbf0016658388"><td class="mdescLeft"> </td><td class="mdescRight">Logs out of Nintendo's friend server. <br /></td></tr>
|
|
<tr class="separator:ad285890ae24b20e4b1fbbf0016658388"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb24d435465d9e70a3d11ef375cfdd38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#acb24d435465d9e70a3d11ef375cfdd38">FRD_Login</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event)</td></tr>
|
|
<tr class="memdesc:acb24d435465d9e70a3d11ef375cfdd38"><td class="mdescLeft"> </td><td class="mdescRight">Log in to Nintendo's friend server. <a href="frd_8h.html#acb24d435465d9e70a3d11ef375cfdd38">More...</a><br /></td></tr>
|
|
<tr class="separator:acb24d435465d9e70a3d11ef375cfdd38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8b838a00088afb5a5917ea67672afe2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ac8b838a00088afb5a5917ea67672afe2">FRD_GetMyFriendKey</a> (<a class="el" href="structFriendKey.html">FriendKey</a> *key)</td></tr>
|
|
<tr class="memdesc:ac8b838a00088afb5a5917ea67672afe2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's friend key. <a href="frd_8h.html#ac8b838a00088afb5a5917ea67672afe2">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8b838a00088afb5a5917ea67672afe2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a103bebd5c600bd4f071c1854ecc2a8b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a103bebd5c600bd4f071c1854ecc2a8b7">FRD_GetMyPreference</a> (bool *isPublicMode, bool *isShowGameName, bool *isShowPlayedGame)</td></tr>
|
|
<tr class="memdesc:a103bebd5c600bd4f071c1854ecc2a8b7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's privacy information. <a href="frd_8h.html#a103bebd5c600bd4f071c1854ecc2a8b7">More...</a><br /></td></tr>
|
|
<tr class="separator:a103bebd5c600bd4f071c1854ecc2a8b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae48da48556a2a63a9498131c3a0ba253"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ae48da48556a2a63a9498131c3a0ba253">FRD_GetMyProfile</a> (<a class="el" href="structFriendProfile.html">FriendProfile</a> *profile)</td></tr>
|
|
<tr class="memdesc:ae48da48556a2a63a9498131c3a0ba253"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's profile information. <a href="frd_8h.html#ae48da48556a2a63a9498131c3a0ba253">More...</a><br /></td></tr>
|
|
<tr class="separator:ae48da48556a2a63a9498131c3a0ba253"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f60c0b3b074a2199030632cab372cd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a4f60c0b3b074a2199030632cab372cd9">FRD_GetMyScreenName</a> (char *name, size_t max_size)</td></tr>
|
|
<tr class="memdesc:a4f60c0b3b074a2199030632cab372cd9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's screen name. <a href="frd_8h.html#a4f60c0b3b074a2199030632cab372cd9">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f60c0b3b074a2199030632cab372cd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2775b6e75e311a34e5d91cc2544b7f94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a2775b6e75e311a34e5d91cc2544b7f94">FRD_GetMyMii</a> (<a class="el" href="structMiiData.html">MiiData</a> *mii)</td></tr>
|
|
<tr class="memdesc:a2775b6e75e311a34e5d91cc2544b7f94"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's Mii data. <a href="frd_8h.html#a2775b6e75e311a34e5d91cc2544b7f94">More...</a><br /></td></tr>
|
|
<tr class="separator:a2775b6e75e311a34e5d91cc2544b7f94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e60ea2b614e06fc65be5400c1390e09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a3e60ea2b614e06fc65be5400c1390e09">FRD_GetMyPlayingGame</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *titleId)</td></tr>
|
|
<tr class="memdesc:a3e60ea2b614e06fc65be5400c1390e09"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's playing game. <a href="frd_8h.html#a3e60ea2b614e06fc65be5400c1390e09">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e60ea2b614e06fc65be5400c1390e09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cfe1c6727abd4a744b40dd1b1c7ed65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a0cfe1c6727abd4a744b40dd1b1c7ed65">FRD_GetMyFavoriteGame</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *titleId)</td></tr>
|
|
<tr class="memdesc:a0cfe1c6727abd4a744b40dd1b1c7ed65"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's favourite game. <a href="frd_8h.html#a0cfe1c6727abd4a744b40dd1b1c7ed65">More...</a><br /></td></tr>
|
|
<tr class="separator:a0cfe1c6727abd4a744b40dd1b1c7ed65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c3a57f3610fec1186404ab3bc4ae3e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a0c3a57f3610fec1186404ab3bc4ae3e7">FRD_GetMyComment</a> (char *comment, size_t max_size)</td></tr>
|
|
<tr class="memdesc:a0c3a57f3610fec1186404ab3bc4ae3e7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's comment on their friend profile. <a href="frd_8h.html#a0c3a57f3610fec1186404ab3bc4ae3e7">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c3a57f3610fec1186404ab3bc4ae3e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1e46d784e56d9d972edc0c49a0c82a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ad1e46d784e56d9d972edc0c49a0c82a5">FRD_GetFriendKeyList</a> (<a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *num, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size)</td></tr>
|
|
<tr class="memdesc:ad1e46d784e56d9d972edc0c49a0c82a5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's friend key list. <a href="frd_8h.html#ad1e46d784e56d9d972edc0c49a0c82a5">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1e46d784e56d9d972edc0c49a0c82a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32a06db92c8333bc1210ac5b85e3f32d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a32a06db92c8333bc1210ac5b85e3f32d">FRD_GetFriendMii</a> (<a class="el" href="structMiiData.html">MiiData</a> *miiDataList, const <a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, size_t size)</td></tr>
|
|
<tr class="memdesc:a32a06db92c8333bc1210ac5b85e3f32d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current user's friends' Mii data. <a href="frd_8h.html#a32a06db92c8333bc1210ac5b85e3f32d">More...</a><br /></td></tr>
|
|
<tr class="separator:a32a06db92c8333bc1210ac5b85e3f32d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad387dd90a8b2fdc9fdfe6fd43e00cdc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#ad387dd90a8b2fdc9fdfe6fd43e00cdc4">FRD_GetFriendProfile</a> (<a class="el" href="structFriendProfile.html">FriendProfile</a> *profile, const <a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, size_t size)</td></tr>
|
|
<tr class="memdesc:ad387dd90a8b2fdc9fdfe6fd43e00cdc4"><td class="mdescLeft"> </td><td class="mdescRight">Get the current user's friends' profile data. <a href="frd_8h.html#ad387dd90a8b2fdc9fdfe6fd43e00cdc4">More...</a><br /></td></tr>
|
|
<tr class="separator:ad387dd90a8b2fdc9fdfe6fd43e00cdc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a721d99c1ec0709cdb5ab0a812cb6b2c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a721d99c1ec0709cdb5ab0a812cb6b2c9">FRD_GetFriendPlayingGame</a> (<a class="el" href="structGameDescription.html">GameDescription</a> *desc, const <a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, size_t size)</td></tr>
|
|
<tr class="memdesc:a721d99c1ec0709cdb5ab0a812cb6b2c9"><td class="mdescLeft"> </td><td class="mdescRight">Get the current user's friends' playing game. <a href="frd_8h.html#a721d99c1ec0709cdb5ab0a812cb6b2c9">More...</a><br /></td></tr>
|
|
<tr class="separator:a721d99c1ec0709cdb5ab0a812cb6b2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f5acb955637da1b6a5ca75239889bb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a6f5acb955637da1b6a5ca75239889bb8">FRD_GetFriendFavouriteGame</a> (<a class="el" href="structGameDescription.html">GameDescription</a> *desc, const <a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> count)</td></tr>
|
|
<tr class="memdesc:a6f5acb955637da1b6a5ca75239889bb8"><td class="mdescLeft"> </td><td class="mdescRight">Get the current user's friends' favourite game. <a href="frd_8h.html#a6f5acb955637da1b6a5ca75239889bb8">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f5acb955637da1b6a5ca75239889bb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40a567b07862845007f429263910db68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a40a567b07862845007f429263910db68">FRD_IsInFriendList</a> (<a class="el" href="structFriendKey.html">FriendKey</a> *friendKeyList, bool *isFromList)</td></tr>
|
|
<tr class="memdesc:a40a567b07862845007f429263910db68"><td class="mdescLeft"> </td><td class="mdescRight">Gets whether a friend key is included in the current user's friend list. <a href="frd_8h.html#a40a567b07862845007f429263910db68">More...</a><br /></td></tr>
|
|
<tr class="separator:a40a567b07862845007f429263910db68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f329cede46001a212236274b15349bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a9f329cede46001a212236274b15349bf">FRD_UpdateGameModeDescription</a> (const char *desc)</td></tr>
|
|
<tr class="memdesc:a9f329cede46001a212236274b15349bf"><td class="mdescLeft"> </td><td class="mdescRight">Updates the game mode description string. <a href="frd_8h.html#a9f329cede46001a212236274b15349bf">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f329cede46001a212236274b15349bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6107bf9a0c2072b25fd4788ddbfeb8d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a6107bf9a0c2072b25fd4788ddbfeb8d6">FRD_AttachToEventNotification</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event)</td></tr>
|
|
<tr class="memdesc:a6107bf9a0c2072b25fd4788ddbfeb8d6"><td class="mdescLeft"> </td><td class="mdescRight">Event which is signaled when friend login states change. <a href="frd_8h.html#a6107bf9a0c2072b25fd4788ddbfeb8d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a6107bf9a0c2072b25fd4788ddbfeb8d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aadba819c10030b47f82ad4d6bcdece07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#aadba819c10030b47f82ad4d6bcdece07">FRD_GetEventNotification</a> (<a class="el" href="structNotificationEvent.html">NotificationEvent</a> *event, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> count, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *recievedNotifCount)</td></tr>
|
|
<tr class="memdesc:aadba819c10030b47f82ad4d6bcdece07"><td class="mdescLeft"> </td><td class="mdescRight">Get Latest Event Notification. <a href="frd_8h.html#aadba819c10030b47f82ad4d6bcdece07">More...</a><br /></td></tr>
|
|
<tr class="separator:aadba819c10030b47f82ad4d6bcdece07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5ed0aecd7ff145f81a2009620d068a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#aa5ed0aecd7ff145f81a2009620d068a5">FRD_PrincipalIdToFriendCode</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *friendCode)</td></tr>
|
|
<tr class="memdesc:aa5ed0aecd7ff145f81a2009620d068a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the friend code using the given principal ID. <a href="frd_8h.html#aa5ed0aecd7ff145f81a2009620d068a5">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5ed0aecd7ff145f81a2009620d068a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef38bc9bd2352ef69c11a1b74092487c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#aef38bc9bd2352ef69c11a1b74092487c">FRD_FriendCodeToPrincipalId</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> friendCode, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *principalId)</td></tr>
|
|
<tr class="memdesc:aef38bc9bd2352ef69c11a1b74092487c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the principal ID using the given friend code. <a href="frd_8h.html#aef38bc9bd2352ef69c11a1b74092487c">More...</a><br /></td></tr>
|
|
<tr class="separator:aef38bc9bd2352ef69c11a1b74092487c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73759a0f468f63a1ed6871e88b84377c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a73759a0f468f63a1ed6871e88b84377c">FRD_IsValidFriendCode</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> friendCode, bool *isValid)</td></tr>
|
|
<tr class="memdesc:a73759a0f468f63a1ed6871e88b84377c"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the friend code is valid. <a href="frd_8h.html#a73759a0f468f63a1ed6871e88b84377c">More...</a><br /></td></tr>
|
|
<tr class="separator:a73759a0f468f63a1ed6871e88b84377c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a910fe457d89b238b0fba46ce7c2340c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a910fe457d89b238b0fba46ce7c2340c3">FRD_SetClientSdkVersion</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sdkVer)</td></tr>
|
|
<tr class="memdesc:a910fe457d89b238b0fba46ce7c2340c3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the Friend API to use a specific SDK version. <a href="frd_8h.html#a910fe457d89b238b0fba46ce7c2340c3">More...</a><br /></td></tr>
|
|
<tr class="separator:a910fe457d89b238b0fba46ce7c2340c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a477f39a31ad43c2bc151e09ee1aa4ade"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a477f39a31ad43c2bc151e09ee1aa4ade">FRD_AddFriendOnline</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId)</td></tr>
|
|
<tr class="memdesc:a477f39a31ad43c2bc151e09ee1aa4ade"><td class="mdescLeft"> </td><td class="mdescRight">Add a Friend online. <a href="frd_8h.html#a477f39a31ad43c2bc151e09ee1aa4ade">More...</a><br /></td></tr>
|
|
<tr class="separator:a477f39a31ad43c2bc151e09ee1aa4ade"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cd1e48a71654365f11439e5f0b3f926"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="frd_8h.html#a6cd1e48a71654365f11439e5f0b3f926">FRD_RemoveFriend</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> localFriendCode)</td></tr>
|
|
<tr class="memdesc:a6cd1e48a71654365f11439e5f0b3f926"><td class="mdescLeft"> </td><td class="mdescRight">Remove a Friend. <a href="frd_8h.html#a6cd1e48a71654365f11439e5f0b3f926">More...</a><br /></td></tr>
|
|
<tr class="separator:a6cd1e48a71654365f11439e5f0b3f926"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Friend Services. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a943bc52f706bd0462355f5dc74d210ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a943bc52f706bd0462355f5dc74d210ce">◆ </a></span>NotificationTypes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce">NotificationTypes</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enum to use with FRD_GetNotificationEvent. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad"></a>USER_WENT_ONLINE </td><td class="fielddoc"><p>Self went online. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99"></a>USER_WENT_OFFLINE </td><td class="fielddoc"><p>Self went offline. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12"></a>FRIEND_WENT_ONLINE </td><td class="fielddoc"><p>Friend Went Online. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d"></a>FRIEND_UPDATED_PRESENCE </td><td class="fielddoc"><p>Friend Presence changed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc"></a>FRIEND_UPDATED_MII </td><td class="fielddoc"><p>Friend Mii changed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902"></a>FRIEND_UPDATED_PROFILE </td><td class="fielddoc"><p>Friend Profile changed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e"></a>FRIEND_WENT_OFFLINE </td><td class="fielddoc"><p>Friend went offline. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8"></a>FRIEND_REGISTERED_USER </td><td class="fielddoc"><p>Friend registered self as friend. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35"></a>FRIEND_SENT_INVITATION </td><td class="fielddoc"><p>Friend Sent invitation. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a477f39a31ad43c2bc151e09ee1aa4ade"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a477f39a31ad43c2bc151e09ee1aa4ade">◆ </a></span>FRD_AddFriendOnline()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_AddFriendOnline </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> </td>
|
|
<td class="paramname"><em>event</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>principalId</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a Friend online. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>Event signaled when friend is registered. </td></tr>
|
|
<tr><td class="paramname">principalId</td><td>PrincipalId of the friend to add. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6107bf9a0c2072b25fd4788ddbfeb8d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6107bf9a0c2072b25fd4788ddbfeb8d6">◆ </a></span>FRD_AttachToEventNotification()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_AttachToEventNotification </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Event which is signaled when friend login states change. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>event which will be signaled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aef38bc9bd2352ef69c11a1b74092487c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aef38bc9bd2352ef69c11a1b74092487c">◆ </a></span>FRD_FriendCodeToPrincipalId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_FriendCodeToPrincipalId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>friendCode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>principalId</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the principal ID using the given friend code. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">friendCode</td><td>The friend code being used. </td></tr>
|
|
<tr><td class="paramname">principalId</td><td>Pointer to write the principal ID to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aadba819c10030b47f82ad4d6bcdece07"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aadba819c10030b47f82ad4d6bcdece07">◆ </a></span>FRD_GetEventNotification()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetEventNotification </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotificationEvent.html">NotificationEvent</a> * </td>
|
|
<td class="paramname"><em>event</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>recievedNotifCount</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get Latest Event Notification. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>Pointer to write recieved notification event struct to. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number of events </td></tr>
|
|
<tr><td class="paramname">recievedNotifCount</td><td>Number of notification reccieved. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f5acb955637da1b6a5ca75239889bb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f5acb955637da1b6a5ca75239889bb8">◆ </a></span>FRD_GetFriendFavouriteGame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetFriendFavouriteGame </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structGameDescription.html">GameDescription</a> * </td>
|
|
<td class="paramname"><em>desc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current user's friends' favourite game. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">desc</td><td>Pointer to write Game Description data to. </td></tr>
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to FriendKeys, </td></tr>
|
|
<tr><td class="paramname">count</td><td>Number Of FriendKeys. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1e46d784e56d9d972edc0c49a0c82a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1e46d784e56d9d972edc0c49a0c82a5">◆ </a></span>FRD_GetFriendKeyList()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetFriendKeyList </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>num</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's friend key list. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to write the friend key list to. </td></tr>
|
|
<tr><td class="paramname">num</td><td>Stores the number of friend keys obtained. </td></tr>
|
|
<tr><td class="paramname">offset</td><td>The index of the friend key to start with. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the friend key list. (FRIEND_LIST_SIZE) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32a06db92c8333bc1210ac5b85e3f32d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32a06db92c8333bc1210ac5b85e3f32d">◆ </a></span>FRD_GetFriendMii()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetFriendMii </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structMiiData.html">MiiData</a> * </td>
|
|
<td class="paramname"><em>miiDataList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's friends' Mii data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">miiDataList</td><td>Pointer to write Mii data to. </td></tr>
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to FriendKeys. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number of Friendkeys. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a721d99c1ec0709cdb5ab0a812cb6b2c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a721d99c1ec0709cdb5ab0a812cb6b2c9">◆ </a></span>FRD_GetFriendPlayingGame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetFriendPlayingGame </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structGameDescription.html">GameDescription</a> * </td>
|
|
<td class="paramname"><em>desc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current user's friends' playing game. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">desc</td><td>Pointer to write Game Description data to. </td></tr>
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to FriendKeys, </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number Of FriendKeys. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad387dd90a8b2fdc9fdfe6fd43e00cdc4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad387dd90a8b2fdc9fdfe6fd43e00cdc4">◆ </a></span>FRD_GetFriendProfile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetFriendProfile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structFriendProfile.html">FriendProfile</a> * </td>
|
|
<td class="paramname"><em>profile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current user's friends' profile data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">profile</td><td>Pointer to write profile data to. </td></tr>
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to FriendKeys. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number of FriendKeys. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c3a57f3610fec1186404ab3bc4ae3e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c3a57f3610fec1186404ab3bc4ae3e7">◆ </a></span>FRD_GetMyComment()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyComment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>comment</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>max_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's comment on their friend profile. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">comment</td><td>Pointer to write the current user's comment to. </td></tr>
|
|
<tr><td class="paramname">max_size</td><td>Max size of the comment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0cfe1c6727abd4a744b40dd1b1c7ed65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cfe1c6727abd4a744b40dd1b1c7ed65">◆ </a></span>FRD_GetMyFavoriteGame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyFavoriteGame </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> * </td>
|
|
<td class="paramname"><em>titleId</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's favourite game. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleId</td><td>Pointer to write the title ID of current user's favourite game to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac8b838a00088afb5a5917ea67672afe2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8b838a00088afb5a5917ea67672afe2">◆ </a></span>FRD_GetMyFriendKey()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyFriendKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's friend key. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Pointer to write the current user's friend key to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2775b6e75e311a34e5d91cc2544b7f94"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2775b6e75e311a34e5d91cc2544b7f94">◆ </a></span>FRD_GetMyMii()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyMii </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structMiiData.html">MiiData</a> * </td>
|
|
<td class="paramname"><em>mii</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's Mii data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mii</td><td>Pointer to write the current user's mii data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e60ea2b614e06fc65be5400c1390e09"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e60ea2b614e06fc65be5400c1390e09">◆ </a></span>FRD_GetMyPlayingGame()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyPlayingGame </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> * </td>
|
|
<td class="paramname"><em>titleId</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's playing game. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleId</td><td>Pointer to write the current user's playing game to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a103bebd5c600bd4f071c1854ecc2a8b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a103bebd5c600bd4f071c1854ecc2a8b7">◆ </a></span>FRD_GetMyPreference()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyPreference </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isPublicMode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isShowGameName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isShowPlayedGame</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's privacy information. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">isPublicMode</td><td>Determines whether friends are notified of the current user's online status. </td></tr>
|
|
<tr><td class="paramname">isShowGameName</td><td>Determines whether friends are notified of the application that the current user is running. </td></tr>
|
|
<tr><td class="paramname">isShowPlayedGame</td><td>Determiens whether to display the current user's game history. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae48da48556a2a63a9498131c3a0ba253"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae48da48556a2a63a9498131c3a0ba253">◆ </a></span>FRD_GetMyProfile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyProfile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structFriendProfile.html">FriendProfile</a> * </td>
|
|
<td class="paramname"><em>profile</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's profile information. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">profile</td><td>Pointer to write the current user's profile information to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f60c0b3b074a2199030632cab372cd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f60c0b3b074a2199030632cab372cd9">◆ </a></span>FRD_GetMyScreenName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_GetMyScreenName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>max_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current user's screen name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Pointer to write the current user's screen name to. </td></tr>
|
|
<tr><td class="paramname">max_size</td><td>Max size of the screen name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40a567b07862845007f429263910db68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40a567b07862845007f429263910db68">◆ </a></span>FRD_IsInFriendList()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_IsInFriendList </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structFriendKey.html">FriendKey</a> * </td>
|
|
<td class="paramname"><em>friendKeyList</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isFromList</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets whether a friend key is included in the current user's friend list. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">friendKeyList</td><td>Pointer to a list of friend keys. </td></tr>
|
|
<tr><td class="paramname">isFromList</td><td>Pointer to a write the friendship status to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73759a0f468f63a1ed6871e88b84377c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73759a0f468f63a1ed6871e88b84377c">◆ </a></span>FRD_IsValidFriendCode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_IsValidFriendCode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>friendCode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isValid</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if the friend code is valid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">friendCode</td><td>The friend code being used. </td></tr>
|
|
<tr><td class="paramname">isValid</td><td>Pointer to write the validity of the friend code to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb24d435465d9e70a3d11ef375cfdd38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb24d435465d9e70a3d11ef375cfdd38">◆ </a></span>FRD_Login()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_Login </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Log in to Nintendo's friend server. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>Event to signal when Login is done. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa5ed0aecd7ff145f81a2009620d068a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5ed0aecd7ff145f81a2009620d068a5">◆ </a></span>FRD_PrincipalIdToFriendCode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_PrincipalIdToFriendCode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>principalId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> * </td>
|
|
<td class="paramname"><em>friendCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the friend code using the given principal ID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">principalId</td><td>The principal ID being used. </td></tr>
|
|
<tr><td class="paramname">friendCode</td><td>Pointer to write the friend code to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6cd1e48a71654365f11439e5f0b3f926"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6cd1e48a71654365f11439e5f0b3f926">◆ </a></span>FRD_RemoveFriend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_RemoveFriend </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>principalId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>localFriendCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove a Friend. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">principalId</td><td>PrinipalId of the friend code to remove. </td></tr>
|
|
<tr><td class="paramname">localFriendCode</td><td>LocalFriendCode of the friend code to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a910fe457d89b238b0fba46ce7c2340c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a910fe457d89b238b0fba46ce7c2340c3">◆ </a></span>FRD_SetClientSdkVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_SetClientSdkVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>sdkVer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the Friend API to use a specific SDK version. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sdkVer</td><td>The SDK version needed to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f329cede46001a212236274b15349bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f329cede46001a212236274b15349bf">◆ </a></span>FRD_UpdateGameModeDescription()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRD_UpdateGameModeDescription </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>desc</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the game mode description string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">desc</td><td>Pointer to write the game mode description to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa1f34be91ea44f0d37c2756f65323975"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa1f34be91ea44f0d37c2756f65323975">◆ </a></span>FRDU_HasLoggedIn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRDU_HasLoggedIn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>state</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the login status of the current user. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>Pointer to write the current user's login status to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aca6f294dad46e3355c891bbad9f681a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca6f294dad46e3355c891bbad9f681a0">◆ </a></span>FRDU_IsOnline()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FRDU_IsOnline </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>state</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the online status of the current user. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>Pointer to write the current user's online status to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|