Files
FC1/Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/group__group__RAECB.html
romkazvo 34d6c5d489 123
2023-08-07 19:29:24 +08:00

78 lines
3.9 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&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>Callbacks<br>
<small>
[<a class="el" href="group__group7.html">Remote Algorithm Execution Service</a>]</small>
</h1>List of the callbacks available in the remote algorithm execution service.
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group__RAECB.html#a0">RemoteAlgorithm_OutputCB</a> )(const GSvoid *pData, GSuint uiRequestId, GSRESULT rResult, const <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a> *pOutput, GSuint uiNumOutput)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback that will receive the output of an algorithm. </em> <a href="#a0"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="a0" doxytag="GSRemoteAlgorithmCB.h::RemoteAlgorithm_OutputCB" ></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"> typedef GSvoid( * <a class="el" href="GSRemoteAlgorithmCB_8h.html#a0">RemoteAlgorithm_OutputCB</a>)( const GSvoid * pData, GSuint uiRequestId, GSRESULT rResult, const <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a> * pOutput, GSuint uiNumOutput)
</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 callback will be called with the output of a previously called remote algorithm. <br>
Related function : <a class="el" href="group__group7__1.html#a3">RemoteAlgorithm_Execute()</a></dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pData</em>&nbsp;</td><td>Custom data passed at the <a class="el" href="group__group7__1.html#a3">RemoteAlgorithm_Execute()</a> call </td></tr>
<tr><td valign=top><em>uiRequestId</em>&nbsp;</td><td>Identifier of the request being replied </td></tr>
<tr><td valign=top><em>rResult</em>&nbsp;</td><td>Result code of the execution. Possible values are: <ul>
<li>
GSS_OK <br>
There was no error </li>
<li>
GSE_DBFAILURE <br>
An error occured on the DB while processing the algorithm. The ubi.com server logs will contain the exact nature of the error. </li>
<li>
GSE_UNEXPECTED <br>
This is an internal error meaning that either the request or the reply was in a format that could not be decoded. </li>
<li>
GSE_HOSTUNREACHABLE <br>
The remote algorithm execution service is not available. </li>
</ul>
</td></tr>
<tr><td valign=top><em>pOutput</em>&nbsp;</td><td>An array of output values from the algorithm. You do not have ownership of this array. The memory will be freed when the callback function returns. </td></tr>
<tr><td valign=top><em>uiNumOutput</em>&nbsp;</td><td>The number of values in the output array </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>