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>nn::friends::CTR::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>Arguments</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>ResultSuccess</CODE></th>
58<td>Process succeeded.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultInvalidPointer</CODE></th>
62<td>An invalid pointer was passed in as an argument.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultTooLarge</CODE></th>
66<td>The size argument was too large.</td>
67        </tr>
68        <tr>
69<th><CODE>ResultNotInitialized</CODE></th>
70<td>The friend presence library has not been initialized.</td>
71        </tr>
72        <tr>
73<th>Other</th>
74<td>Some other result may be returned as a result of factors such as the daemon's internal state.</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>Empty profile information is returned in the given buffer if no friends correspond to the keys passed in as arguments. Empty profile information may also be returned if the friend has never disclosed being in the online state. But even in this case, the function itself returns a value indicating success.<br /></p><p>For empty profile information, the platform code is invariably <CODE>0</CODE>. As for data such as the region code, you cannot distinguish valid values from that information itself, so be sure to determine the platform code.</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>Clarified that empty profile information may also be returned if a given friend has never disclosed being in the online state.<br />Added text about the method of determining empty profile information.<br />
85        </dd>
86        <dt>2011/03/11</dt>
87<dd>Noted that this function returns a value indicating success even when it returns empty profile information.<br />Revised some text under <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>