123
This commit is contained in:
romkazvo
@@ -0,0 +1,163 @@
|
||||
<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>General functionalities</h1>General functionalities.
|
||||
<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>GShandle </td><td class="memItemRight" valign=bottom><a class="el" href="group__group1.html#a0">GSCDKey_Initialize</a> (GSushort usPort)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the cd key library. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSvoid </td><td class="memItemRight" valign=bottom><a class="el" href="group__group1.html#a1">GSCDKey_Uninitialize</a> (GShandle pGSCDKeyHandle=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uinitialize a cd key handle or the whole library. </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__group1.html#a2">GSCDKey_Engine</a> (GShandle pGSCDKeyHandle, GSuint uiMaxDelay=500)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Message pump. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These functions are used both by the game client and game server. They are use to initialize, uninitialize the library and process incomming/outgoing messages. <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a2" doxytag="GSCDKeyInterface.h::GSCDKey_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 GSCDKey_Engine </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GShandle </td>
|
||||
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiMaxDelay</em> = 500</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 send outgoing messages and process incomming messages. To insure smooth operation of the library, this function should be called at least 10 time a second. It will return GS_FALSE if the provided cd key handle is not valid.</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 operation suceeded. </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>the operation failed.</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>pGSCDKeyHandle</em> </td><td>Handle on the cd key module </td></tr>
|
||||
<tr><td valign=top><em>uiMaxDelay</em> </td><td>Maximum number of milisecond spent on processing messages </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSCDKeyInterface.h::GSCDKey_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"> GShandle GSCDKey_Initialize </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSushort </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>usPort</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 will initialize the cd key library, on success it will return a handle that can be use for futur calls on this service. The provided port will be reserved for library communication and will be freed once the library is uninitialized, if the supplied port is not available (already binded) on the local machine, the initialization will fail.</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>Handle</em> </td><td>on the created cd key module </td></tr>
|
||||
<tr><td valign=top><em>0</em> </td><td>if the operation failed</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>usPort</em> </td><td>The port on wich the client will listen to. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSCDKeyInterface.h::GSCDKey_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"> GSvoid GSCDKey_Uninitialize </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GShandle </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>pGSCDKeyHandle</em> = 0 </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 will uninitialize a provided cd key handle or it will uninitialize all cd key handle if no argument are supplied.</dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>pGSCDKeyHandle</em> </td><td>Handle on the cd key module </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>
|
||||
Reference in New Issue
Block a user