RomkaZVO/FC1
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

123

Browse Source
This commit is contained in:
romkazvo
2023-08-07 19:29:24 +08:00
commit 34d6c5d489
4832 changed files with 1389451 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

468
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/group__group6__2.html Normal file
View File

@@ -0,0 +1,468 @@
<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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>Results fetching<br>
<small>
[<a class="el" href="group__group6.html">Ladder Query Service</a>]</small>
</h1>Get the entries requested when a request completed successfully.
<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&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a0">LadderQuery_GetResultSearchCount</a> (GSuint uiRequestID, GSuint &amp;uiCount)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the request search count. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a1">LadderQuery_GetResultEntryCount</a> (GSuint uiRequestID, GSuint &amp;uiCount)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the request entry count. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a2">LadderQuery_GetResultFieldCaption</a> (GSuint uiRequestID, const GSchar *pszField, GSchar *pszCaption)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the pretty name of a field. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a3">LadderQuery_StartResultEntryEnumeration</a> (GSuint uiRequestID, GSuint uiStartEntry=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start the entry enumeration. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a4">LadderQuery_NextResultEntry</a> (GSuint uiRequestID)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the results set pointer to the next entry (iteration). </em> <a href="#a4"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField</a> (GSuint uiRequestID, const GSchar *pszField, GSint &amp;iValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current numeric field value. </em> <a href="#a5"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString</a> (GSuint uiRequestID, const GSchar *pszField, GSchar *pszValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current field value in a string format. </em> <a href="#a6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>GSvoid&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a7">LadderQuery_ReleaseResult</a> (GSuint uiRequestID)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release the results set from memory. </em> <a href="#a7"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These functions are used to fetch results from a request that came back to the client library. <hr><h2>Function Documentation</h2>
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LadderQuery_GetCurrentEntryField" ></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_GetCurrentEntryField </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>pszField</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSint &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>iValue</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to get the numeric field value currently pointed by the results set pointer. It is used in conjonction with <a class="el" href="group__group6__2.html#a4">LadderQuery_NextResultEntry()</a> to iterate through the list of entries in the results set and get their values. <b>NOTE</b>: <em>If the entry is a character string, this function will return GS_FALSE.</em> </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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>pszField</em>&nbsp;</td><td>Pointer to a character string representing the field name. </td></tr>
<tr><td valign=top><em>iValue</em>&nbsp;</td><td>[OUT] The numeric field value retrieved. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LadderQuery_GetCurrentEntryFieldAsString" ></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_GetCurrentEntryFieldAsString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>pszField</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>pszValue</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to get the field value currently pointed by the results set pointer in a string format. It is used in conjonction with <a class="el" href="group__group6__2.html#a4">LadderQuery_NextResultEntry()</a> to iterate through the list of entries in the results set and get their values.</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>pszField</em>&nbsp;</td><td>Pointer to a character string representing the field name. </td></tr>
<tr><td valign=top><em>pszValue</em>&nbsp;</td><td>[OUT] Pointer to a character string representing the field value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::LadderQuery_GetResultEntryCount" ></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_GetResultEntryCount </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSuint &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>uiCount</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function will return the number of entries that were returned as part of the results set.</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>uiCount</em>&nbsp;</td><td>[OUT] The number of entries in the results set. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LadderQuery_GetResultFieldCaption" ></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_GetResultFieldCaption </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>pszField</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>pszCaption</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function will get the name of a field like it should be displayed in the game (pretty name). Example: Field name "TIME" = Field caption "Total time played"</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>pszField</em>&nbsp;</td><td>Pointer to a character string representing the field name to identify. </td></tr>
<tr><td valign=top><em>pszCaption</em>&nbsp;</td><td>[OUT] Pointer to a character string that will represent the field caption on success. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::LadderQuery_GetResultSearchCount" ></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_GetResultSearchCount </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSuint &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>uiCount</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function will return the number of valid entries that were found on server for the request that was sent. This number may differ from the number of entries returned in the results set. See <a class="el" href="group__group6__2.html#a1">LadderQuery_GetResultEntryCount()</a>.</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>uiCount</em>&nbsp;</td><td>[OUT] The number of entries matching the request specifications. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LadderQuery_NextResultEntry" ></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_NextResultEntry </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>uiRequestID</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function will move the results set pointer to the next entry in the list of entries received. It is used in conjonction with <a class="el" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField()</a> and <a class="el" href="group__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString()</a> to iterate through the list of entries in the results set and get their values.</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LadderQuery_ReleaseResult" ></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"> GSvoid LadderQuery_ReleaseResult </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>uiRequestID</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to release the results received from the server after no more operations on the results set need to be done. Each successfull request triggers a memory allocation for the results, these results need to be flushed when they are not used anymore.</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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LadderQuery_StartResultEntryEnumeration" ></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_StartResultEntryEnumeration </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSuint&nbsp;</td>
<td class="mdname" nowrap> <em>uiStartEntry</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function will initialise the enumeration of entries received in the results set. This call is important and must be done before any call to <a class="el" href="group__group6__2.html#a4">LadderQuery_NextResultEntry()</a> , <a class="el" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField()</a> , and <a class="el" href="group__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString()</a> . <b>NOTE</b>: <em>Since you can call this function multiple times without modifying the results set, you can use this function to get the results in the order you want by modifying the uiStartEntry parameter.</em></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>&nbsp;</td><td>Success </td></tr>
<tr><td valign=top><em>GS_FALSE</em>&nbsp;</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>uiRequestID</em>&nbsp;</td><td>The request identifier supplied in the callback. </td></tr>
<tr><td valign=top><em>uiStartEntry</em>&nbsp;</td><td>The index of the entry where the enumeration will start. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>
<p align="right">
<i>Ubi.com GameService SDK - &copy;UbiSoft Entertainment 2002 </i><br>
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
</p>
</body>
</html>