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>GetEventNotification</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>::GetEventNotification</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn_types/u32.html">u32</a> GetEventNotification(
15     <a href="../../../nnfriendsEventNotification/Overview.html">EventNotification</a> * pEventNotificationList,
16     size_t size = 1,
17     bool * pHasOverflowed = NULL
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><CODE>pEventNotificationList</CODE></th>
34<td>Specifies a pointer to a buffer storing the content of the obtained notifications.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>size</th>
39<td>Specifies the number of elements in the buffer.</td>
40        </tr>
41        <tr>
42<td>out</td>
43<th>pHasOverflowed</th>
44<td>Specifies a pointer to a buffer that stores whether there has been notification that there was an overflow without acquisition. Specify <CODE>NULL</CODE> if not needed.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the number of notifications actually obtained. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Gets the history of notifications of changes in the local user's online state and/or friends' online states.</p><p>Use this function to get the content of notifications that had not yet been obtained, in order from oldest to newest. To get backlogged notifications in chronological order, call this function repeatedly until the return value is <CODE>0</CODE>.<br /><br />The library can save up to 128 notifications. If there are already 128 notifications saved and another is received, the oldest is discarded. The number of notifications saved might change in future.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2011/03/11</dt>
56<dd>Added specific examples of return values.<br />
57        </dd>
58        <dt>2010/08/16</dt>
59<dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>
65