1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>GetFriendPresence</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/friends/Overview.html">friends</a>::<a href="../../../nn/friends/CTR/Overview.html">CTR</a>::GetFriendPresence</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetFriendPresence(
15     <a href="../../../nnfriendsFriendPresence/Overview.html">FriendPresence</a> * pFriendPresenceList,
16     const <a href="../../../nnfriendsFriendKey/Overview.html">FriendKey</a> * pFriendKeyList,
17     size_t size = 1
18);
19</pre>
20    </div>
21<h2>Parameters</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>out</td>
33<th>pFriendPresenceList</th>
34<td>Specifies a pointer to a buffer storing obtained friend presence information.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>pFriendKeyList</th>
39<td>Specifies a pointer to a list of friend keys.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>size</th>
44<td>Specifies the number of buffer elements in the friend key list.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the result of the operation.<br /> <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52<th>Value</th>
53<td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57<th><CODE>Result::IsSuccess</CODE></th>
58<td>Process succeeded.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultInvalidPointer</CODE></th>
62<td>Invalid pointer passed as argument.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultTooLarge</CODE></th>
66<td>The value passed as the argument is too large.</td>
67        </tr>
68        <tr>
69<th><CODE>ResultNotInitialized</CODE></th>
70<td>The friend presence library is not initialized.</td>
71        </tr>
72        <tr>
73<th>Other</th>
74<td>Another result may be returned, depending on the internal state of the daemon and other factors.</td>
75        </tr>
76      </table> </div>
77<h2>Description</h2>
78    <div class="section">
79<p>Gets a list of friend presence information.</p><p>Cannot acquire the invitation flag and game mode of a friend who has a different matchmaking game ID specified.<br /><br />Returns an empty presence in this buffer if there is no friend corresponding to the key passed in the arguments. In this case the function still returns success.<br /><br />The function retrieves an empty presence when a non-existent friend is specified. This is represented by a <CODE><a href="../../../nn/friends/CTR/FriendPresence.html">nn::friends::CTR::FriendPresence</a></CODE> structure that has <CODE>isValid</CODE> set to <CODE>false</CODE>. If the friend is offline, or has made the online status private, then the obtained presence will have <CODE>isValid</CODE> set to <CODE>true</CODE>, but <CODE>isOnline</CODE> will be <CODE>false</CODE>, and the <CODE>gameMode</CODE> structure will be filled with zeros. </p><!-- write here --></div>
80<h2>Revision History</h2>
81    <div class="section">
82      <dl class="history">
83        <dt>2011/10/26</dt>
84<dd>Added note about values of obtained presence flags.
85        </dd>
86        <dt>2011/03/11</dt>
87<dd>Noted that the function will still return success even if an empty presence is returned.<br />Revised a part of text in <B>Description</B>.<br />Added specific examples of return values.<br />
88        </dd>
89        <dt>2010/08/16</dt>
90<dd>Initial version.<br />
91        </dd>
92      </dl>
93    </div>
94  <hr><p>CONFIDENTIAL</p></body>
95</html>