RomkaZVO/FC1
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
34d6c5d489611da93eb41d9afd4744c00da9f517
FC1/Ubisoft.com/GSServices/sdks/gs-sdk-cdkey/doc-api/group__group3.html
romkazvo 34d6c5d489 123
2023-08-07 19:29:24 +08:00

151 lines
7.9 KiB
HTML
Raw Blame History

<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>Game client functionalities</h1>Game client 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><a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group3.html#a0">GSCDKey_RequestActivation</a> (GShandle pGSCDKeyHandle, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, <a class="el" href="struct__ACTIVATION__INFO.html">PACTIVATION_INFO</a> psActivationInfo, GSushort usTimeout=6)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request cd key activation id for futur authorization request (called once). </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group3.html#a1">GSCDKey_RequestAuthorization</a> (GShandle pGSCDKeyHandle, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, <a class="el" href="struct__VALIDATION__INFO.html">PVALIDATION_INFO</a> psValidationInfo, GSushort usTimeout=3)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a authorization request to the validation server. </em> <a href="#a1"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These functions are used by the game client to request a activation and validation information from the validation server. <hr><h2>Function Documentation</h2>
<a class="anchor" name="a0" doxytag="GSCDKeyInterface.h::GSCDKey_RequestActivation" ></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"> <a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a> GSCDKey_RequestActivation </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GShandle&nbsp;</td>
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationServerInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__ACTIVATION__INFO.html">PACTIVATION_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psActivationInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSushort&nbsp;</td>
<td class="mdname" nowrap> <em>usTimeout</em> = 6</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 activation id that will be use in futur client authentication. This function should be called the first time a cd key authentication is needed (i.g. the first time a user plays online after the game installation). The activation id should be safely kept so that each subsequent authorization request use that activation id. After calling this request, the result will be returned via the CBCDKey_RcvActivationID callback. 0 means a unlimited timeout value.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The id of the request</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pGSCDKeyHandle</em>&nbsp;</td><td>Handle on the created cd key module </td></tr>
<tr><td valign=top><em>psValidationServerInfo</em>&nbsp;</td><td>Validation server information </td></tr>
<tr><td valign=top><em>psActivationInfo</em>&nbsp;</td><td>Validation information </td></tr>
<tr><td valign=top><em>usTimeout</em>&nbsp;</td><td>Number of second before the request is considered timed out default for this request is 6. 0 means a unlimited timeout value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="GSCDKeyInterface.h::GSCDKey_RequestAuthorization" ></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"> <a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a> GSCDKey_RequestAuthorization </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GShandle&nbsp;</td>
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationServerInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__INFO.html">PVALIDATION_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSushort&nbsp;</td>
<td class="mdname" nowrap> <em>usTimeout</em> = 3</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 validate a cd key before joining a game server. The validation information structure contains the activation id and the cd key. After having receive the result from this request via the CBCDKey_RcvAuthorizationID callback, the user can join a game server wich will ask the validation server for the player status (authenticated or not)</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The id of the request</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pGSCDKeyHandle</em>&nbsp;</td><td>Handle on the created cd key module </td></tr>
<tr><td valign=top><em>psValidationServerInfo</em>&nbsp;</td><td>Validation server information </td></tr>
<tr><td valign=top><em>psValidationInfo</em>&nbsp;</td><td>Validation information </td></tr>
<tr><td valign=top><em>usTimeout</em>&nbsp;</td><td>Number of second before the request is considered timed out default for this request is 3. 0 means a unlimited timeout value. </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>
Reference in New Issue View Git Blame Copy Permalink