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>GetFriendKeyList</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>::GetFriendKeyList</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetFriendKeyList(
15     <a href="../../../nnfriendsFriendKey/Overview.html">FriendKey</a> * pFriendKeyList,
16     size_t * pNum,
17     size_t offset = 0,
18     size_t size = FRIEND_LIST_SIZE
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th>pFriendKeyList</th>
35<td>Specifies a pointer to a buffer that stores obtained friend keys.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>pNum</th>
40<td>Specifies a pointer to a buffer that stores the number actually obtained.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>offset</th>
45<td>Specifies the index of the friend key to begin obtaining.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>size</th>
50<td>Specifies the maximum number of friend keys to obtain (the number of buffer elements).</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation.<br /> <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>Result::IsSuccess</CODE></th>
64<td>Process succeeded.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidPointer</CODE></th>
68<td>Invalid pointer passed as argument.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultTooLarge</CODE></th>
72<td>The value passed as the argument is too large.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultNotInitialized</CODE></th>
76<td>The friend presence library is not initialized.</td>
77        </tr>
78        <tr>
79<th>Other</th>
80<td>Another result may be returned, depending on the internal state of the daemon and other factors.</td>
81        </tr>
82      </table> </div>
83<h2>Description</h2>
84    <div class="section">
85<p>Gets a list of the friend keys registered in the friend list.</p><p>The obtained friend keys also include peers who have not yet established a friend relationship with the local host.</p><!-- write here --></div>
86<h2>Revision History</h2>
87    <div class="section">
88      <dl class="history">
89        <dt>2011/03/11</dt>
90<dd>Added specific examples of return values.<br />
91        </dd>
92        <dt>2010/08/16</dt>
93<dd>Initial version.<br />
94        </dd>
95      </dl>
96    </div>
97  <hr><p>CONFIDENTIAL</p></body>
98</html>
99