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>nn::friends::CTR::GetFriendScreenName</CODE> Function</h1> 11<h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"> 14<a href="../../../nn/Result/Overview.html">Result</a> GetFriendScreenName( 15 char16(*) pScreenNameList[SCREEN_NAME_SIZE], 16 const <a href="../../../nn/friends/CTR/PrincipalId.html">PrincipalId</a> * pPrincipalIdList, 17 size_t size = 1, 18 bool replaceForeignCharacters = true, 19 u8 * pFontRegionList = NULL 20); 21</pre> 22 </div> 23<h2>Arguments</h2> 24 <div class="section"> 25 <table class="arguments"> 26 <thead> 27 <tr> 28 <td width="15" /> 29<th>Name</th> 30<td>Description</td> 31 </tr> 32 </thead> 33 <tr> 34<td>out</td> 35<th>pScreenNameList[SCREEN_NAME_SIZE]</th> 36<td>Specifies a pointer to a buffer that stores acquired screen names.</td> 37 </tr> 38 <tr> 39<td>in</td> 40<th>pPrincipalIdList</th> 41<td>Specifies a pointer to a list of principal IDs.</td> 42 </tr> 43 <tr> 44<td>in</td> 45<th>size</th> 46<td>Specifies the number of buffer elements in the principal ID list.</td> 47 </tr> 48 <tr> 49<td>in</td> 50<th>replaceForeignCharacters</th> 51<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> 52 </tr> 53 <tr> 54<td>in</td> 55<th>pFontRegionList</th> 56<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> 57 </tr> </table> 58 </div> 59<h2>Return Values</h2> 60<div class="section">Returns the result of the operation.<br /> <br /> 61 <table class="arguments"> 62 <thead> 63 <tr> 64<th>Value</th> 65<td>Description</td> 66 </tr> 67 </thead> 68 <tr> 69<th><CODE>ResultSuccess</CODE></th> 70<td>Process succeeded.</td> 71 </tr> 72 <tr> 73<th><CODE>ResultInvalidPointer</CODE></th> 74<td>An invalid pointer was passed in as an argument.</td> 75 </tr> 76 <tr> 77<th><CODE>ResultTooLarge</CODE></th> 78<td>The size argument was too large.</td> 79 </tr> 80 <tr> 81<th><CODE>ResultNotInitialized</CODE></th> 82<td>The friend presence library has not been initialized.</td> 83 </tr> 84 <tr> 85<th>Other</th> 86<td>Some other result may be returned as a result of factors such as the daemon's internal state.</td> 87 </tr> 88 </table> </div> 89<h2>Description</h2> 90 <div class="section"> 91<p>Gets a list of friend screen names.</p><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 />Empty screen names are returned in the given buffer if no friends correspond to the keys passed in as arguments. Even in this case, the function itself returns a value indicating success.</p><!-- write here --></div> 92<h2>Revision History</h2> 93 <div class="section"> 94 <dl class="history"> 95 <dt>2011/03/11</dt> 96<dd>Noted that this function returns a value indicating success even when it returns empty screen names.<br />Revised some text under <B>Description</B>.<br />Added specific examples of return values.<br /> 97 </dd> 98 <dt>2010/11/10</dt> 99<dd>Initial version.<br /> 100 </dd> 101 </dl> 102 </div> 103 <hr><p>CONFIDENTIAL</p></body> 104</html> 105