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>GetFriendProfile</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>::GetFriendProfile</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetFriendProfile(
15     <a href="../../../nnfriendsProfile/Overview.html">Profile</a> * pProfileList,
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>pProfileList</th>
34<td>Specifies a pointer to a buffer storing obtained profile 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 friends' profile information.</p><p>Returns empty profile information in this buffer if there is no friend corresponding to the key passed in the arguments. The function will also return empty profile information if the peer has never published its online status. The function itself will still return success in this case.<br /></p><p>The platform code of empty profile information is always <CODE>0</CODE>. If you cannot tell if a value by itself is valid (for example, a region code), always use the platform code to determine validity.</p><!-- write here --></div>
80<h2>Revision History</h2>
81    <div class="section">
82      <dl class="history">
83        <dt>2011/03/30</dt>
84<dd>Added note that empty profile information may also be returned if the friend has never published its online status.<br />Added method for determining if profile information is empty.<br /><br />
85        </dd>
86        <dt>2011/03/11</dt>
87<dd>Noted that the function will still return success even if empty profile information is returned.<br />Fixed typos in description.<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>
96