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>GetFriendScreenName</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>::GetFriendScreenName</CODE> Function</h1> 11<h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"><a href="../../../nn/Result/Overview.html">Result</a> GetFriendScreenName( 14 char16 (*pScreenNameList)[SCREEN_NAME_SIZE], 15 const <a href="../../../nn/friends/CTR/PrincipalId.html">PrincipalId</a> * pPrincipalIdList, 16 size_t size = 1, 17 bool replaceForeignCharacters = true, 18 u8 * pFontRegionList = NULL 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"></td> 28<th>Name</th> 29<td>Description</td> 30 </tr> 31 </thead> 32 <tr> 33<td>out</td> 34<th>pScreenNameList[SCREEN_NAME_SIZE]</th> 35<td>Specifies a pointer to a buffer that stores acquired screen names.</td> 36 </tr> 37 <tr> 38<td>in</td> 39<th>pPrincipalIdList</th> 40<td>Specifies a pointer to a list of principal IDs.</td> 41 </tr> 42 <tr> 43<td>in</td> 44<th>size</th> 45<td>Specifies the number of buffer elements in the principal ID list.</td> 46 </tr> 47 <tr> 48<td>in</td> 49<th>replaceForeignCharacters</th> 50<td>When the font region of the friend's screen name is different than one's own, specifies to use "?" in place of non-ASCII characters.</td> 51 </tr> 52 <tr> 53<td>in</td> 54<th>pFontRegionList</th> 55<td>Specifies a pointer to a buffer that stores the font region of a friend's screen name. Specify <CODE>NULL</CODE> if not needed.</td> 56 </tr> 57 </table> 58 </div> 59<h2>Return Values</h2> 60 <div class="section"> 61Returns the result of the operation. <br /><br /> 62 <table class="arguments"> 63 <thead> 64<tr><th>Value</th><td>Description</td></tr> 65 </thead> 66 <tr> 67<th><CODE>Result::IsSuccess</CODE></th> 68<td>Process succeeded.</td> 69 </tr> 70 <tr> 71<th><CODE>ResultInvalidPointer</CODE></th> 72<td>Invalid pointer passed as argument.</td> 73 </tr> 74 <tr> 75<th><CODE>ResultTooLarge</CODE></th> 76<td>The value passed as the argument is too large.</td> 77 </tr> 78 <tr> 79<th><CODE>ResultNotInitialized</CODE></th> 80<td>The friend presence library is not initialized.</td> 81 </tr> 82 <tr> 83<th>Other</th> 84<td>Another result may be returned, depending on the internal state of the daemon and other factors.</td> 85 </tr> 86 </table> 87 </div> 88<h2>Description</h2> 89 <div class="section"> 90<p>Gets a list of friend screen names.</p> 91<p>By calling this function, you can get the name of a friend's Mii character directly without using the Mii library. Even if you have not yet established a friend relationship with this person and cannot get his or her Mii character, the display name that you have tentatively registered is obtained.<br /><br />The actual name of a friend's Mii character is obtained even when it is in the blacklist, but the obtained name is replaced with "???" if it contains profanity.<br /><br />Returns an empty display name in this buffer if there is no friend corresponding to the key passed in the arguments. The function still returns success in this case.</p><!-- write here --> 92 </div> 93<h2>Revision History</h2> 94 <div class="section"> 95 <dl class="history"> 96 <dt>2011/03/11</dt> 97<dd>Noted that the function still returns successfully even if an empty display name is returned.<br />Revised <B>Description</B>.<br />Added specific examples of return values.<br /></dd> 98 <dt>2010/11/10</dt> 99<dd>Initial version.<br /></dd> 100 </dl> 101 </div> 102 <hr><p>CONFIDENTIAL</p></body> 103</html>