1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3 4<head> 5<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows"> 8<title>DWC_RnkGetScoreAsync</title> 9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13<a name="dwc__ranking_8h_198665927b3a87b3218c1f58f6f3394ba"></a> 14<h1 align="left">DWC_RnkGetScoreAsync</h1> 15<h2>Syntax</h2> 16 17<dl> 18 <dd> 19<CODE>#include <dwc.h></CODE><BR> 20 <BR> 21 <PRE><CODE><a href=Macro.html#dwc__ranking_8h_11e26643f8161b162f689f7031ace5910>DWCRnkError</a> <a href=DWC_RnkGetScoreAsync.html#dwc__ranking_8h_198665927b3a87b3218c1f58f6f3394ba>DWC_RnkGetScoreAsync</a>(<a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b19>DWCRnkGetMode</a> mode, 22 u32 category, 23 <a href=Macro.html#dwc__ranking_8h_1bc0db3fbc51ac91811958f9c51e87899>DWCRnkRegion</a> region, 24 <a href=DWCRnkGetParam.html#>DWCRnkGetParam</a> *param);</CODE></PRE></dd> 25</dl> 26 27<h2>Arguments</h2> 28 29<TABLE border="1" width="100%"> 30 <TBODY> 31 32 <TR> 33<TD width="13%"><EM><STRONG>mode</STRONG></EM></TD> 34<TD width="87%">The retrieval mode.</TD> 35 </TR> 36 37 <TR> 38<TD width="13%"><EM><STRONG>category</STRONG></EM></TD> 39<TD width="87%">Category ID for identifying rankings (category ID is a numeric value ranging from zero to <a href=Macro.html#dwc__ranking_8h_192c348bb621e1f4486daf931679df6d1><CODE>DWC_RNK_CATEGORY_MAX</CODE></a>).</TD> 40 </TR> 41 42 <TR> 43<TD width="13%"><EM><STRONG>region</STRONG></EM></TD> 44<TD width="87%">The region code. Specified from inside <a href=Macro.html#dwc__ranking_8h_1bc0db3fbc51ac91811958f9c51e87899><CODE>DWCRnkRegion</CODE></a>. Specify an OR value when collecting data from multiple regions (Example: For Japan and Europe (<a href=Macro.html#dwc__ranking_8h_1bc0db3fbc51ac91811958f9c51e87899039bfac4d629c2a463d410b07ce6ac6d><CODE>DWC_RNK_REGION_JP</CODE></a>|<a href=Macro.html#dwc__ranking_8h_1bc0db3fbc51ac91811958f9c51e87899039bfac4d629c2a463d410b07ce6ac6d><CODE>DWC_RNK_REGION_EU</CODE></a>)).</TD> 45 </TR> 46 47 <TR> 48<TD width="13%"><EM><STRONG>param</STRONG></EM></TD> 49<TD width="87%">Parameter that specifies detailed information in order to perform retrieval. The value specified in the structure will differ depending on the retrieval mode. For more details, see the <A href="DWCRnkGetParam.html"><CODE>DWCRnkGetParam</CODE></a> structure.</TD> 50 </TR> 51 52 </TBODY> 53</TABLE> 54 55<h2>Return Values</h2> 56 57<TABLE border="1" width="100%"> 58 <TBODY> 59 60 <TR> 61<TD width="13%"><EM><STRONG>DWC_RNK_SUCCESS</STRONG></EM></TD> 62<TD width="87%">Succeeded.</TD> 63 </TR> 64 65 <TR> 66<TD width="13%"><EM><STRONG>DWC_RNK_IN_ERROR</STRONG></EM></TD> 67<TD width="87%">An error is occurring.</TD> 68 </TR> 69 70 <TR> 71<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_GET_NOTREADY</STRONG></EM></TD> 72<TD width="87%">Communications could not be prepared.</TD> 73 </TR> 74 75 <TR> 76<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INVALID_PARAMETER</STRONG></EM></TD> 77<TD width="87%">Invalid parameter.</TD> 78 </TR> 79 80 <TR> 81<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_GET_INVALID_KEY</STRONG></EM></TD> 82<TD width="87%">Invalid encryption key.</TD> 83 </TR> 84 85 <TR> 86<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_GET_NOMEMORY</STRONG></EM></TD> 87<TD width="87%">Insufficient memory.</TD> 88 </TR> 89 90 </TBODY> 91</TABLE> 92 93<H2>Description</H2> 94<p>Starts the asynchronous process for obtaining the score. Only one asynchronous process can be run at a time. <a href=Macro.html#dwc__ranking_8h_11e26643f8161b162f689f7031ace5910267a9266ab011bc4ec1248366c195821><CODE>DWC_RNK_ERROR_PUT_NOTREADY</CODE></a> is returned if an attempt is made to execute more than one asynchronous process.</p><p>Make periodic calls to the <A href="DWC_RnkProcess.html"><CODE>DWC_RnkProcess</CODE></a> function during the asynchronous process. During the process, <A href="DWC_RnkProcess.html"><CODE>DWC_RnkProcess</CODE></a> returns <a href=Macro.html#dwc__ranking_8h_11e26643f8161b162f689f7031ace591031d9ef7155e9c704fd07f83f72ad0077><CODE>DWC_RNK_SUCCESS</CODE></a>.</p><p>Call the <A href="DWC_RnkGetState.html"><CODE>DWC_RnkGetState</CODE></a> function to get the state of progress of the asynchronous process.</p><p>Be sure to make backups as necessary when executing asynchronous processes in succession because some members inside the <A href="DWCRnkData.html"><CODE>DWCRnkData</CODE></a>structure obtained using the <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> function directly access the receive buffer.</p><p><table border="1"><tr><td><br>Values that can be specified for the <CODE>mode</CODE> argument, and the information that is retrieved as a result:<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b192780d834ce449ab6c433688a1301e6d2>DWC_RNK_GET_MODE_ORDER</a><br></td><td><br>Gets the order. The results are obtained with <A href="DWC_RnkResGetOrder.html"><CODE>DWC_RnkResGetOrder</CODE></a>.<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b196a28982348d7e68f741fe17f02119472>DWC_RNK_GET_MODE_TOPLIST</a><br></td><td><br>Gets the top of the ranking list. Gets the number of rows in the list obtained using <A href="DWC_RnkResGetRowCount.html"><CODE>DWC_RnkResGetRowCount</CODE></a> and calls <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> for each row to get score information.<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b1922d34a9fa74dd2c8fe71b86cda14dd45>DWC_RNK_GET_MODE_NEAR_HI</a><br></td><td><br>Gets a list of nearby rankings that are higher than one's own ranking. Gets the number of rows in the list obtained using <A href="DWC_RnkResGetRowCount.html"><CODE>DWC_RnkResGetRowCount</CODE></a> and calls <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> for each row to get score information. One's own data is added to the top of the list.<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b19adf73378f9a269eaa9e782fe4a77109d>DWC_RNK_GET_MODE_NEAR_LOW</a><br></td><td><br>Gets a list of nearby rankings that are lower than one's own ranking. Gets the number of rows in the list obtained using <A href="DWC_RnkResGetRowCount.html"><CODE>DWC_RnkResGetRowCount</CODE></a> and calls <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> for each row to get score information. One's own data is added to the top of the list.<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b199ed73aff5c4f370195419350b5922250>DWC_RNK_GET_MODE_NEAR</a><br></td><td><br>Gets a list of rankings near one's own. Gets the number of rows in the list obtained using <A href="DWC_RnkResGetRowCount.html"><CODE>DWC_RnkResGetRowCount</CODE></a> and calls <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> for each row to get score information. One's own data is added to the top of the list.<br></td></tr><tr><td><br><a href=Macro.html#dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b19dabfeed2395ed84700e7d7510b46ca00>DWC_RNK_GET_MODE_FRIENDS</a><br></td><td><br> Gets a list of rankings among one's friends (the maximum number of PIDs that may be specified is <a href=Macro.html#dwc__ranking_8h_1913f4aa84f44c33e7a5dfbf0b48cd92d><CODE>DWC_RNK_FRIENDS_MAX</CODE></a> (64)). Uses the <a href="DWC_RnkResGetRowCount.html"><CODE>DWC_RnkResGetRowCount</CODE></a> function to get the number of rows in the list, then gets the score information by calling the <A href="DWC_RnkResGetRow.html"><CODE>DWC_RnkResGetRow</CODE></a> function for every row. One's own data is added to the top of the list.<br></td></tr></table></p><p>To exchange information that is limited to friends, such as free word communication that contains user-defined data, the friend relationship must be verified before displaying the information based on the guidelines.</p> 95 96<H2>Revision History</H2> 97<DL> 98 99<DT><para>1.4.5</DT> 100<DD>Added <CODE>DWC_RNK_GET_MODE_HI</CODE>.<br>Added <CODE>DWC_RNK_GET_MODE_LOW</CODE>.</DD> 101 102<DT><para>1.4.8</DT> 103<DD>Corrected text, changing "the score is higher/lower than one's own" to "the ranking is higher/lower than one's own", and deleted the text "Lists starting with data closest to your own score" from Nearby Rankings. </DD> 104 105</DL> 106<hr><p>CONFIDENTIAL</p></body> 107</html> 108