673 lines
30 KiB
HTML
673 lines
30 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__group1.html">Login Service</a>]</small>
|
|
</h1>Messages sent to the game service.
|
|
<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__group1__1.html#a0">Login_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status-messages handling relating to the login 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__group1__1.html#a1">LoginSend_Connect</a> (const GSchar *szAddress, GSushort usPort)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to the router. </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__1.html#a2">LoginSend_Disconnect</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the router. </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__group1__1.html#a3">LoginSend_LoginRouter</a> (const GSchar *szUsername, const GSchar *szPassword, const GSchar *szVersion, GSbool bPublicIP=GS_TRUE)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Login to the router. </em> <a href="#a3"></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__1.html#a4">LoginSend_JoinWaitModule</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ask to join the wait module. </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__group1__1.html#a5">LoginSend_LoginWaitModule</a> (const GSchar *szUsername)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Login to the wait module. </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__group1__1.html#a6">LoginSend_PlayerInfo</a> (const GSchar *szUsername)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get player account information. </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__group1__1.html#a7">LoginSend_Sleep</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put player in sleep mode. </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__group1__1.html#a8">LoginSend_WakeUp</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put player in awake mode. </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__group1__1.html#a9">LoginSend_ModifyAccount</a> (const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modify player informations. </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__group1__1.html#a10">LoginSend_CreateAccount</a> (const GSchar *szVersion, const GSchar *szUsername, const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Account creation. </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__group1__1.html#a11">LoginSend_RequestMOTD</a> (const GSchar *szLanguage)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request the message of the day. </em> <a href="#a11"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
These function are used to send login-related messages to the server <hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::Login_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 Login_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 login service. This function should be called regularly to ensure that the application will run smoothly.</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="a1" doxytag="GSClientLibrary.h::LoginSend_Connect" ></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 LoginSend_Connect </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szAddress</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSushort </td>
|
|
<td class="mdname" nowrap> <em>usPort</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 is opens a connect to the router or wait module. When this function returns successfully <a class="el" href="group__group1__1.html#a3">LoginSend_LoginRouter()</a> should be called. When connecting to the wait module you should call <a class="el" href="group__group1__1.html#a5">LoginSend_LoginWaitModule()</a> next.</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>Connection established </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failed to established connection</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szAddress</em> </td><td>Router's IP address </td></tr>
|
|
<tr><td valign=top><em>usPort</em> </td><td>Router's client port number </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::LoginSend_CreateAccount" ></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 LoginSend_CreateAccount </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szVersion</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szFirstName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szLastName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szEmail</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szCountry</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 is used to create a new account on the gs network <b>NOTE</b>: <em>You have to call this function before login to the waitmodule.</em> and after the LoginSend_Connect function.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a6">CBLoginRcv_AccountCreationResult</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> </td><td>Account created successfully </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to create account</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szVersion</em> </td><td>Version of the player'client </td></tr>
|
|
<tr><td valign=top><em>szUsername</em> </td><td>Username of the player </td></tr>
|
|
<tr><td valign=top><em>szPassword</em> </td><td>Password of the new player </td></tr>
|
|
<tr><td valign=top><em>szFirstName</em> </td><td>Player's first name </td></tr>
|
|
<tr><td valign=top><em>szLastName</em> </td><td>Player's last name </td></tr>
|
|
<tr><td valign=top><em>szEmail</em> </td><td>Player's email </td></tr>
|
|
<tr><td valign=top><em>szCountry</em> </td><td>Player's country </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LoginSend_Disconnect" ></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 LoginSend_Disconnect </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>Disconnect from the Server</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>Disconnection successfull </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failed to disconnect </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LoginSend_JoinWaitModule" ></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 LoginSend_JoinWaitModule </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 is used to ask to join the wait module the router will respond with the ip and port of the wait module to join. This should only be called after receving a successfull <a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a></dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a1">CBLoginRcv_JoinWaitModuleResult</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> </td><td>Request successfull </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Request failure </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LoginSend_LoginRouter" ></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 LoginSend_LoginRouter </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szUsername</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szVersion</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSbool </td>
|
|
<td class="mdname" nowrap> <em>bPublicIP</em> = GS_TRUE</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 is used to login to the router using your username and password for your game service account. The szVersion parameter will is the games client version. This will be given to you by the Game Service developers.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</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> </td><td>Login successfull </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Login 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>szUsername</em> </td><td>The username of the player that wants to log in </td></tr>
|
|
<tr><td valign=top><em>szPassword</em> </td><td>The password </td></tr>
|
|
<tr><td valign=top><em>szVersion</em> </td><td>The version of the client </td></tr>
|
|
<tr><td valign=top><em>bPublicIP</em> </td><td>If this flag is enabled, the ip address will be sent to players in your along with others player infos, if not your ip will not be sent to other players, thus preventing them to ping you. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LoginSend_LoginWaitModule" ></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 LoginSend_LoginWaitModule </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>szUsername</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 is used to login to the waitmodule. It should only be called after successfully using <a class="el" href="group__group1__1.html#a1">LoginSend_Connect()</a> to connect to the wait module.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a3">CBLoginRcv_LoginWaitModuleResult</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> </td><td>Login successfull </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Login 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>szUsername</em> </td><td>The Username of the player </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::LoginSend_ModifyAccount" ></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 LoginSend_ModifyAccount </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szFirstName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szLastName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szEmail</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szCountry</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 is used to modify account information for a player.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a7">CBLoginRcv_ModifyUserResult</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> </td><td>Successfully modify the account </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to modify the account</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szPassword</em> </td><td>the new Password for the player </td></tr>
|
|
<tr><td valign=top><em>szFirstName</em> </td><td>the new First name for the player </td></tr>
|
|
<tr><td valign=top><em>szLastName</em> </td><td>the new Last name for the player </td></tr>
|
|
<tr><td valign=top><em>szEmail</em> </td><td>the new Email for the player </td></tr>
|
|
<tr><td valign=top><em>szCountry</em> </td><td>the new Country for the player </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LoginSend_PlayerInfo" ></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 LoginSend_PlayerInfo </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>szUsername</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 is used to get information stored for a player. Inorder to use the chat sdk it is important to call this on yourself after sucessfully logging in. This is because you must get your szIRCID before using chat and the correct case for the username.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a0">CBLoginRcv_PlayerInfo</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> </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>szUsername</em> </td><td>The username of the the player you want the info of. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::LoginSend_RequestMOTD" ></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 LoginSend_RequestMOTD </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>szLanguage</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 asks the server to send the message of the day based the client version and the requested language. If the request language is not available it will default to english.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LoginCB.html#a8">CBLoginRcv_RequestMOTD</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> </td><td>Account created successfully </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to create account</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szLanguage</em> </td><td>The language to receive the MOTD in. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LoginSend_Sleep" ></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 LoginSend_Sleep </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 is used to put the player in sleep mode, which means he will not receive any message from the server until he calls <a class="el" href="group__group1__1.html#a8">LoginSend_WakeUp()</a>. The message are stored when a player is in sleep mode.</dd></dl>
|
|
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a8">LoginSend_WakeUp()</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> </td><td>Successfully put in sleep mode </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to put in sleep mode </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::LoginSend_WakeUp" ></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 LoginSend_WakeUp </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 is used to put the player in "awake" mode which means that he will start to receive message from the router again. Any system and page messages that were saved while the player was asleep will be sent.</dd></dl>
|
|
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a7">LoginSend_Sleep()</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> </td><td>Successfully put in awake mode </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to put in awake mode </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>
|