656 lines
29 KiB
HTML
656 lines
29 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<TITLE>Ubi.com GameService SDK</TITLE>
|
|
<LINK href="./gs-sdk-doc.css" rel="stylesheet" type="text/css">
|
|
</HEAD>
|
|
|
|
<BODY >
|
|
<!-- Generated by Doxygen 1.3.4 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
|
<h1>Functions<br>
|
|
<small>
|
|
[<a class="el" href="group__group6.html">Ladder Query Service</a>]</small>
|
|
</h1>Messages sent to the <b><em>ladder query service</em></b>.
|
|
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a0">LadderQuery_Initialize</a> (GSchar *szLocale)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the ladder query service. </em> <a href="#a0"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a1">LadderQuery_Uninitialize</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialization function for the ladder query service. </em> <a href="#a1"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a2">LadderQuery_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status related to the ladder query service. </em> <a href="#a2"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a3">LadderQuery_CreateRequest</a> (GSchar *szGameName, GSuint uiEvent=0, GSuint uiMode=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a basic ladder query request. </em> <a href="#a3"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a4">LadderQuery_SendRequest</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a request over the network. </em> <a href="#a4"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a5">LadderQuery_RequestPivotUser</a> (const GSchar *pszEntry, GSuint uiNumberOfEntries)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (username). </em> <a href="#a5"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a6">LadderQuery_RequestPivotRow</a> (GSuint uiRowNumber, GSuint uiNumberOfEntries)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (row number). </em> <a href="#a6"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a7">LadderQuery_RequestSet</a> (const GSchar *pszEntries[], GSuint uiNumberOfEntries)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting a pre-defined set of entries. </em> <a href="#a7"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a8">LadderQuery_RequestOrderedList</a> (GSuint uiFirstEntry, GSuint uiNumberOfEntries)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries from a starting index (row number). </em> <a href="#a8"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a9">LadderQuery_AddSortConstraint</a> (const GSchar *pszField, GSbool bSortDirection)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>sort</b> constraint to a created request. </em> <a href="#a9"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a10">LadderQuery_AddFilterConstraint</a> (const <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> *pLadderFilter[], GSuint uiListOfFilters)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>filter</b> constraint to a created request. </em> <a href="#a10"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a11">LadderQuery_AddDisplayConstraint</a> (const GSchar *pszFields[], GSuint uiNumberOfFields)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>display</b> constraint to a created request. </em> <a href="#a11"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
These functions are used to send request to the ubi.com data provider and retrieve results when a reply is given by the server. <hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::LadderQuery_AddDisplayConstraint" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_AddDisplayConstraint </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>pszFields</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiNumberOfFields</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set a display constraint to a request that has been created. Display constraint will make the results contain only the supplied list of fields.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pszFields</em> </td><td>A pointer to an array of string values (fields). </td></tr>
|
|
<tr><td valign=top><em>uiNumberOfFields</em> </td><td>The size of the array of string values. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::LadderQuery_AddFilterConstraint" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_AddFilterConstraint </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> * </td>
|
|
<td class="mdname" nowrap> <em>pLadderFilter</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiListOfFilters</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set a filter constraint to a request that has been created. Filters are defined using the <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> structure.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pLadderFilter</em> </td><td>A pointer to an array of ladder filter. </td></tr>
|
|
<tr><td valign=top><em>uiListOfFilters</em> </td><td>The size of the array of ladder filter. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::LadderQuery_AddSortConstraint" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_AddSortConstraint </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>pszField</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSbool </td>
|
|
<td class="mdname" nowrap> <em>bSortDirection</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set a sort constraint to a request that has been created.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pszField</em> </td><td>The field name to sort by. </td></tr>
|
|
<tr><td valign=top><em>bSortDirection</em> </td><td>The sort direction where GS_TRUE = natural order and GS_FALSE = unnatural order. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LadderQuery_CreateRequest" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_CreateRequest </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szGameName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiEvent</em> = 0, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiMode</em> = 0</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function creates a basic ladder query request (ordered list, with no constraint) that can be sent over the network to the ubi.com data provider. The <a class="el" href="group__group6__1.html#a3">LadderQuery_CreateRequest()</a> function should be called each time you want to make a request. Once the request is created, you can tell which type of request you want, and optionally add one or more constraint. If you call this function again before sending the request created previously, the type and constraint of the previous request are overwritten by the default ones.</dd></dl>
|
|
<b>NOTE</b>: <em>This function will return GS_FALSE if you have not completed the login sequence on the gs-router server.</em><p>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szGameName</em> </td><td>The game name associated with the requested ladder data. </td></tr>
|
|
<tr><td valign=top><em>uiEvent</em> </td><td>The event id associated with the ladder data. </td></tr>
|
|
<tr><td valign=top><em>uiMode</em> </td><td>The game mode. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LadderQuery_Engine" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_Engine </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiMaxPostingDelay</em> = 500, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiMaxsOperationalDelay</em> = 800</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Updates the connection between the client and the server, and handles the delivery of queued up messages and reception of messages relating to the ladder query service service. This function should be called regularly to ensure that the service will run smoothly and properly.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>The connection is ok and function call was a success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>There has been a communication problem between the client and the server</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>uiMaxPostingDelay</em> </td><td>The maximum time to be spent inside the engine to read incomming messages and posting them to the message queue. (Milliseconds) </td></tr>
|
|
<tr><td valign=top><em>uiMaxsOperationalDelay</em> </td><td>The maximum time to be spent inside the engine to decode message in the queue and calling appropriate callback. (Milliseconds) </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::LadderQuery_Initialize" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_Initialize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSchar * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>szLocale</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function takes a 2 character string argument that represent the locale in which the string results will be returned from the server.</dd></dl>
|
|
The initialisation of the ladder query service can be done after the client library initialization (i.g. <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary_Initialize()</a>)<p>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szLocale</em> </td><td>The locale in which the string results will be returned from the server. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::LadderQuery_RequestOrderedList" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_RequestOrderedList </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiFirstEntry</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiNumberOfEntries</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set the request mode to retrieve an ordered list of entries from a starting zero-based index representing a row number.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>uiFirstEntry</em> </td><td>Zero-based index of the first entry to get. </td></tr>
|
|
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries in the array of values. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LadderQuery_RequestPivotRow" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_RequestPivotRow </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiRowNumber</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiNumberOfEntries</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set the request mode to retrieve an ordered list of entries around a pivot where the pivot is a row number in the ladder.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>uiRowNumber</em> </td><td>The row number used as a pivot. </td></tr>
|
|
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries to retrieve. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LadderQuery_RequestPivotUser" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_RequestPivotUser </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>pszEntry</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiNumberOfEntries</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set the request mode to retrieve an ordered list of entries around a pivot where the pivot is a user name entry.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pszEntry</em> </td><td>Pointer to a character string representing the username to use as a pivot. </td></tr>
|
|
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries to retrieve. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LadderQuery_RequestSet" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_RequestSet </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>pszEntries</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiNumberOfEntries</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function set the request mode to retrieve a pre-defined set of entries supplied by the caller.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pszEntries</em> </td><td>Pointer on an array of string values. Each string values should be a username. </td></tr>
|
|
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries in the array of values. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LadderQuery_SendRequest" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSuint LadderQuery_SendRequest </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function send a request over the network to the ubi.com servers. This function will return the id of the sent request and in case of error it will return 0. The id of the request will be used once we get the results so you have to keep it in memory.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>The id of the request that has been sent.</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>0</em> </td><td>Internal error </td></tr>
|
|
<tr><td valign=top><em>else</em> </td><td>The id of the request that has been sent. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::LadderQuery_Uninitialize" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> GSbool LadderQuery_Uninitialize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This function uninitialize the ladder query service and free allocated memory.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr>
|
|
<p align="right">
|
|
<i>Ubi.com GameService SDK - ©UbiSoft Entertainment 2002 </i><br>
|
|
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
|
</p>
|
|
</body>
|
|
</html>
|