123
This commit is contained in:
romkazvo
@@ -0,0 +1,186 @@
|
||||
<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>GSClientClass.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef _GSCLIENCLASS_H_</span>
|
||||
00002 <span class="preprocessor"></span><span class="preprocessor">#define _GSCLIENCLASS_H_</span>
|
||||
00003 <span class="preprocessor"></span>
|
||||
00004 <span class="preprocessor">#include "GSErrors.h"</span>
|
||||
00005 <span class="preprocessor">#include "<a class="code" href="GSLoginCB_8h.html">GSLoginCB.h</a>"</span>
|
||||
00006 <span class="preprocessor">#include "<a class="code" href="GSFriendsCB_8h.html">GSFriendsCB.h</a>"</span>
|
||||
00007 <span class="preprocessor">#include "<a class="code" href="GSLobbyCB_8h.html">GSLobbyCB.h</a>"</span>
|
||||
00008 <span class="preprocessor">#include "<a class="code" href="GSPersistentCB_8h.html">GSPersistentCB.h</a>"</span>
|
||||
00009 <span class="preprocessor">#include "<a class="code" href="GSLadderQueryCB_8h.html">GSLadderQueryCB.h</a>"</span>
|
||||
00010 <span class="preprocessor">#include "GSRemoteAlgorithmCB.h"</span>
|
||||
00011 <span class="preprocessor">#include "<a class="code" href="LadderDefines_8h.html">LadderDefines.h</a>"</span>
|
||||
00012 <span class="preprocessor">#include "RemoteAlgorithmDefines.h"</span>
|
||||
00013
|
||||
00014 <span class="keyword">class </span>CGLClientLIB;
|
||||
00015
|
||||
00016 <span class="keyword">class </span>clGLClient : <span class="keyword">public</span> clLoginCallbacks, <span class="keyword">public</span> clFriendsCallbacks,
|
||||
00017 <span class="keyword">public</span> clLobbyCallbacks, <span class="keyword">public</span> clPersistentCallbacks,
|
||||
00018 <span class="keyword">public</span> clLadderQueryCallbacks
|
||||
00019 {
|
||||
00020 <span class="keyword">public</span>:
|
||||
00021 clGLClient();
|
||||
00022 <span class="keyword">virtual</span> ~clGLClient();
|
||||
00023
|
||||
00024 GSbool GL_AddRouterPing(GSint lID, GSchar *szIPAddress, GSint lPort);
|
||||
00025 GSbool GL_GetFirstPing(GSint *plID);
|
||||
00026 GSbool GL_ClearRouterPing();
|
||||
00027
|
||||
00028 <span class="comment">//Login Messages</span>
|
||||
00029 GSbool <a class="code" href="group__group1__1.html#a0">Login_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00030 GSbool <a class="code" href="group__group1__1.html#a1">LoginSend_Connect</a>(<span class="keyword">const</span> GSchar* szAddress, GSushort lPort);
|
||||
00031 GSbool <a class="code" href="group__group1__1.html#a2">LoginSend_Disconnect</a>();
|
||||
00032 GSbool <a class="code" href="group__group1__1.html#a3">LoginSend_LoginRouter</a>(<span class="keyword">const</span> GSchar* szAlias, <span class="keyword">const</span> GSchar* szPassword,
|
||||
00033 <span class="keyword">const</span> GSchar* szVersion, GSbool bPublicIP = GS_TRUE);
|
||||
00034 GSbool <a class="code" href="group__group1__1.html#a5">LoginSend_LoginWaitModule</a>(<span class="keyword">const</span> GSchar* szAlias);
|
||||
00035 GSbool <a class="code" href="group__group1__1.html#a4">LoginSend_JoinWaitModule</a>();
|
||||
00036 GSbool <a class="code" href="group__group1__1.html#a6">LoginSend_PlayerInfo</a>(<span class="keyword">const</span> GSchar* szAlias);
|
||||
00037 GSbool <a class="code" href="group__group1__1.html#a7">LoginSend_Sleep</a>();
|
||||
00038 GSbool <a class="code" href="group__group1__1.html#a8">LoginSend_WakeUp</a>();
|
||||
00039 GSbool <a class="code" href="group__group1__1.html#a9">LoginSend_ModifyAccount</a>(<span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSchar* szFirstName,
|
||||
00040 <span class="keyword">const</span> GSchar* szLastName, <span class="keyword">const</span> GSchar* szEmail, <span class="keyword">const</span> GSchar* szCountry);
|
||||
00041 GSbool <a class="code" href="group__group1__1.html#a10">LoginSend_CreateAccount</a>(<span class="keyword">const</span> GSchar* szVersion, <span class="keyword">const</span> GSchar* szNickName, <span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSchar* szFirstName,
|
||||
00042 <span class="keyword">const</span> GSchar* szLastName, <span class="keyword">const</span> GSchar* szEmail, <span class="keyword">const</span> GSchar* szCountry);
|
||||
00043 GSbool <a class="code" href="group__group1__1.html#a11">LoginSend_RequestMOTD</a>(<span class="keyword">const</span> GSchar *szLanguage);
|
||||
00044
|
||||
00045 <span class="comment">//Friends Messages</span>
|
||||
00046 GSbool <a class="code" href="group__group2__1.html#a0">Friends_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00047 GSbool <a class="code" href="group__group2__1.html#a1">FriendsSend_Connect</a>();
|
||||
00048 GSbool <a class="code" href="group__group2__1.html#a2">FriendsSend_Disconnect</a>();
|
||||
00049 GSbool <a class="code" href="group__group2__1.html#a3">FriendsSend_Login</a>(GSint lStatus = 0, GSint lMood = 0);
|
||||
00050 GSbool <a class="code" href="group__group2__1.html#a4">FriendsSend_AddFriend</a>(<span class="keyword">const</span> GSchar* szFriend, <span class="keyword">const</span> GSchar* szGroup, GSint lOptions);
|
||||
00051 GSbool <a class="code" href="group__group2__1.html#a5">FriendsSend_DelFriend</a> (<span class="keyword">const</span> GSchar* szFriend);
|
||||
00052 GSbool <a class="code" href="group__group2__1.html#a6">FriendsSend_FriendList</a>();
|
||||
00053
|
||||
00054 GSRESULT <a class="code" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer</a>( <span class="keyword">const</span> GSchar * szPlayer );
|
||||
00055 GSRESULT <a class="code" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer</a>( <span class="keyword">const</span> GSchar * szPlayer);
|
||||
00056 GSRESULT <a class="code" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers</a>();
|
||||
00057
|
||||
00058 GSbool <a class="code" href="group__group2__1.html#a10">FriendsSend_PagePlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, <span class="keyword">const</span> GSchar* szMessage);
|
||||
00059 GSbool <a class="code" href="group__group2__1.html#a11">FriendsSend_PeerPlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, GSvoid *p_Buffer, GSuint uiLength);
|
||||
00060 GSbool <a class="code" href="group__group2__1.html#a12">FriendsSend_StatusChange</a>(GSint lStatus, GSint lMood);
|
||||
00061 GSbool <a class="code" href="group__group2__1.html#a13">FriendsSend_ChangeFriend</a>(<span class="keyword">const</span> GSchar* szFriend, <span class="keyword">const</span> GSchar* szGroup, GSint lOptions);
|
||||
00062 GSbool <a class="code" href="group__group2__1.html#a14">FriendsSend_SearchPlayer</a>(<span class="keyword">const</span> GSchar* pszAlias, <span class="keyword">const</span> GSchar* pszSurName, <span class="keyword">const</span> GSchar* pszFirstName, <span class="keyword">const</span> GSchar* pszCountry, <span class="keyword">const</span> GSchar* pszEmail, GSint lSex, <span class="keyword">const</span> GSchar* pszGame);
|
||||
00063 GSbool <a class="code" href="group__group2__1.html#a15">FriendsSend_GetPlayerScores</a>(<span class="keyword">const</span> GSchar* pszAlias);
|
||||
00064
|
||||
00065 <span class="comment">//Lobby messages</span>
|
||||
00066 GSbool <a class="code" href="group__group4__1.html#a0">Lobby_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00067 GSbool <a class="code" href="group__group4__1.html#a1">LobbySend_Connect</a>();
|
||||
00068 GSbool <a class="code" href="group__group4__1.html#a4">LobbySend_Login</a>(<span class="keyword">const</span> GSchar* szGames, GSbool bPublicIP = GS_TRUE, GSushort usPlayerStatus = 0 );
|
||||
00069 GSbool <a class="code" href="group__group4__1.html#a2">LobbySend_Disconnect</a>(GSint iLobbyServerID);
|
||||
00070 GSbool <a class="code" href="group__group4__1.html#a3">LobbySend_DisconnectAll</a>();
|
||||
00071
|
||||
00072 GSbool <a class="code" href="group__group4__1.html#a8">LobbySend_CreateRoom</a>(GSint iParentGroupID, GSint iLobbyServerID, <span class="keyword">const</span> GSchar *szRoomName,
|
||||
00073 <span class="keyword">const</span> GSchar *szGames, GSushort usRoomType, GSushort usMaxPlayers, GSushort usMaxVisitors,
|
||||
00074 <span class="keyword">const</span> GSvoid *vpData, GSint iSize, <span class="keyword">const</span> GSvoid* vpAltGroupInfo, GSint iAltGroupInfoSize,
|
||||
00075 <span class="keyword">const</span> GSchar *szPassword, <span class="keyword">const</span> GSchar *szGameVersion, <span class="keyword">const</span> GSchar *szGSVersion);
|
||||
00076
|
||||
00077 GSbool <a class="code" href="group__group4__1.html#a5">LobbySend_JoinLobby</a>(GSint iGroupID, GSint iLobbyServerID,
|
||||
00078 <span class="keyword">const</span> GSchar *szPassword, GSint iConfig = 0);
|
||||
00079 GSbool <a class="code" href="group__group4__1.html#a6">LobbySend_JoinRoom</a>(GSint iGroupID, GSint iLobbyServerID, <span class="keyword">const</span> GSchar *szPassword,
|
||||
00080 GSbool bVisitor, <span class="keyword">const</span> GSchar *szVersion, GSint iConfig = 0);
|
||||
00081 GSbool <a class="code" href="group__group4__1.html#a7">LobbySend_LeaveGroup</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00082
|
||||
00083 GSbool <a class="code" href="group__group4__1.html#a17">LobbySend_GetGroupInfo</a>(GSint iGroupID, GSint iLobbyServerID, GSint iconfig);
|
||||
00084 GSbool <a class="code" href="group__group4__1.html#a18">LobbySend_GetAlternateGroupInfo</a>(GSint iGroupID, GSint iLobbyServerID );
|
||||
00085
|
||||
00086 GSbool <a class="code" href="group__group4__1.html#a19">LobbySend_InitMatchResults</a>(GSuint uiMatchID);
|
||||
00087 GSbool <a class="code" href="group__group4__1.html#a20">LobbySend_SetMatchResult</a>(GSchar *szAlias, GSuint uiFieldID, GSint iFieldValue);
|
||||
00088 GSbool <a class="code" href="group__group4__1.html#a21">LobbySend_SubmitMatchResult</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00089 GSbool <a class="code" href="group__group4__1.html#a22">LobbySend_ClearMatchResult</a>();
|
||||
00090
|
||||
00091 GSbool <a class="code" href="group__group4__1.html#a9">LobbySend_StartMatch</a>(GSint iGroupID, GSint iLobbyServerID, GSuint uiMode = 0 );
|
||||
00092 GSbool <a class="code" href="group__group4__1.html#a10">LobbySend_MatchFinish</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00093 GSbool <a class="code" href="group__group4__1.html#a12">LobbySend_PlayerMatchStarted</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00094 GSbool <a class="code" href="group__group4__1.html#a13">LobbySend_PlayerMatchFinished</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00095
|
||||
00096 GSbool <a class="code" href="group__group4__1.html#a11">LobbySend_NewMaster</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias);
|
||||
00097 GSbool <a class="code" href="group__group4__1.html#a14">LobbySend_PlayerKick</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias, GSchar *szReason);
|
||||
00098 GSbool <a class="code" href="group__group4__1.html#a15">LobbySend_GetParentGroupID</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00099 GSbool <a class="code" href="group__group4__1.html#a16">LobbySend_UpdateRoomConfig</a>(GSint iGroupID, GSint iLobbyServerID, GSbyte bDedicatedServer,
|
||||
00100 GSbyte bOpen, GSbyte bScore_Submission, GSint iMaxPlayers,
|
||||
00101 GSint iMaxVisitors, <span class="keyword">const</span> GSchar* szPassword, <span class="keyword">const</span> GSvoid* vpData,
|
||||
00102 GSint iSize, <span class="keyword">const</span> GSvoid* vpAltGroupInfo, GSint iGroupInfoSize );
|
||||
00103
|
||||
00104 GSbool <a class="code" href="group__group4__1.html#a24">LobbySend_GameStart</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00105 GSbool <a class="code" href="group__group4__1.html#a27">LobbySend_GameReady</a>(GSint iGroupID, GSint iLobbyServerID, GSvoid* vpGameData, GSint iSize,
|
||||
00106 GSushort usPort = 0, GSchar *szIPAddress = 0);
|
||||
00107 GSbool <a class="code" href="group__group4__1.html#a26">LobbySend_GameFinish</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00108 GSbool <a class="code" href="group__group4__1.html#a25">LobbySend_GameConnected</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00109
|
||||
00110 GSbool <a class="code" href="group__group4__1.html#a28">LobbySend_UpdateGameInfo</a>(GSint iGroupID, GSint iLobbyServerID, GSvoid* vpGameData, GSint iSize,
|
||||
00111 GSushort usPort = 0, GSchar *szIPAddress = 0);
|
||||
00112 GSbool <a class="code" href="group__group4__1.html#a29">LobbySend_PlayerBan</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias, GSchar *szReason);
|
||||
00113 GSbool <a class="code" href="group__group4__1.html#a30">LobbySend_PlayerUnBan</a>(GSint iGroupID, GSint iLobbyServerID, GSchar *szAlias);
|
||||
00114 GSbool <a class="code" href="group__group4__1.html#a31">LobbySend_GetPlayerBannedList</a>(GSint iGroupID, GSint iLobbyServerID);
|
||||
00115 GSbool <a class="code" href="group__group4__1.html#a32">LobbySend_SetPlayerInfo</a>(GSvoid *vpPlayerData, GSint iPlayerDataSize);
|
||||
00116 GSbool <a class="code" href="group__group4__1.html#a33">LobbySend_GetPlayerGroups</a>(GSchar *szAlias);
|
||||
00117 GSbool <a class="code" href="group__group4__1.html#a34">LobbySend_ChangeRequestedLobbies</a>(<span class="keyword">const</span> GSchar* szGames);
|
||||
00118
|
||||
00119 GSbool <a class="code" href="group__group5__1.html#a2">PS_Engine</a>(GSuint uiMaxPostingDelay = 500, GSuint uiMaxsOperationalDelay = 800);
|
||||
00120 GSbool <a class="code" href="group__group5__1.html#a0">PSSend_Login</a>();
|
||||
00121 GSbool <a class="code" href="group__group5__1.html#a1">PSSend_Disconnect</a>();
|
||||
00122 GSuint <a class="code" href="group__group5__1.html#a3">PSSend_GetPrivateData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00123 GSint iRecordID);
|
||||
00124 GSuint <a class="code" href="group__group5__1.html#a4">PSSend_SetPrivateData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00125 GSint iRecordID, <span class="keyword">const</span> GSvoid *vpData, GSint iSize);
|
||||
00126 GSuint <a class="code" href="group__group5__1.html#a5">PSSend_GetPublicData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00127 GSint iRecordID, <span class="keyword">const</span> GSchar *szPlayerAlias = 0);
|
||||
00128 GSuint <a class="code" href="group__group5__1.html#a6">PSSend_SetPublicData</a>(<span class="keyword">const</span> GSchar *szGame, GSint iEventID,
|
||||
00129 GSint iRecordID, <span class="keyword">const</span> GSvoid *vpData, GSint iSize);
|
||||
00130
|
||||
00131 GSbool <a class="code" href="group__group6__1.html#a0">LadderQuery_Initialize</a>(GSchar *szLocale);
|
||||
00132 GSbool <a class="code" href="group__group6__1.html#a1">LadderQuery_Uninitialize</a>();
|
||||
00133 GSbool <a class="code" href="group__group6__1.html#a2">LadderQuery_Engine</a>(GSuint uiMaxPostingDelay = 500,GSuint uiMaxsOperationalDelay = 800);
|
||||
00134 GSuint <a class="code" href="group__group6__1.html#a4">LadderQuery_SendRequest</a>();
|
||||
00135
|
||||
00136 GSbool <a class="code" href="group__group6__1.html#a3">LadderQuery_CreateRequest</a>(GSchar *szGameName, GSuint uiEvent = 0, GSuint uiMode = 0);
|
||||
00137 GSbool <a class="code" href="group__group6__1.html#a5">LadderQuery_RequestPivotUser</a>(<span class="keyword">const</span> GSchar *pszEntry, GSuint uiNumberOfEntries);
|
||||
00138 GSbool <a class="code" href="group__group6__1.html#a6">LadderQuery_RequestPivotRow</a>(GSuint uiEntry, GSuint uiNumberOfEntries);
|
||||
00139 GSbool <a class="code" href="group__group6__1.html#a7">LadderQuery_RequestSet</a>(<span class="keyword">const</span> GSchar *pszEntries[], GSuint uiNumberOfEntries);
|
||||
00140 GSbool <a class="code" href="group__group6__1.html#a8">LadderQuery_RequestOrderedList</a>(GSuint uiFirstEntry, GSuint uiNumberOfEntries);
|
||||
00141
|
||||
00142 GSbool <a class="code" href="group__group6__1.html#a9">LadderQuery_AddSortConstraint</a>(<span class="keyword">const</span> GSchar *pszField, GSbool bSortDirection);
|
||||
00143 GSbool <a class="code" href="group__group6__1.html#a10">LadderQuery_AddFilterConstraint</a>(<span class="keyword">const</span> <a class="code" href="structLADDER__FILTER.html">LADDER_FILTER</a> *pLadderFilter[], GSuint uiListOfFilters);
|
||||
00144 GSbool <a class="code" href="group__group6__1.html#a11">LadderQuery_AddDisplayConstraint</a>(<span class="keyword">const</span> GSchar *pszFields[], GSuint uiNumberOfFields);
|
||||
00145
|
||||
00146 GSbool <a class="code" href="group__group6__2.html#a0">LadderQuery_GetResultSearchCount</a>(GSuint uiRequestID, GSuint & uiCount);
|
||||
00147 GSbool <a class="code" href="group__group6__2.html#a1">LadderQuery_GetResultEntryCount</a>(GSuint uiRequestID, GSuint & uiCount);
|
||||
00148 GSbool <a class="code" href="group__group6__2.html#a2">LadderQuery_GetResultFieldCaption</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSchar * pszCaption);
|
||||
00149 GSbool <a class="code" href="group__group6__2.html#a3">LadderQuery_StartResultEntryEnumeration</a>(GSuint uiRequestID, GSuint uiStartEntry);
|
||||
00150 GSbool <a class="code" href="group__group6__2.html#a4">LadderQuery_NextResultEntry</a>(GSuint uiRequestID);
|
||||
00151 GSbool <a class="code" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSint & iValue);
|
||||
00152 GSbool <a class="code" href="group__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString</a>(GSuint uiRequestID, <span class="keyword">const</span> GSchar *pszField, GSchar * pszValue);
|
||||
00153 GSvoid <a class="code" href="group__group6__2.html#a7">LadderQuery_ReleaseResult</a>(GSuint uiRequestID);
|
||||
00154
|
||||
00155 GSRESULT <a class="code" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise</a>(<span class="keyword">const</span> GSchar * szGameName);
|
||||
00156 GSRESULT <a class="code" href="group__group7__1.html#a1">RemoteAlgorithm_Uninitialise</a>();
|
||||
00157 GSRESULT <a class="code" href="group__group7__1.html#a2">RemoteAlgorithm_Engine</a>(GSuint uiMaxPostingDelay = 500,
|
||||
00158 GSuint uiMaxsOperationalDelay = 800);
|
||||
00159 GSRESULT <a class="code" href="group__group7__1.html#a3">RemoteAlgorithm_Execute</a>(GSuint uiAlgoId,
|
||||
00160 <a class="code" href="structRAE__VALUE.html">RAE_VALUE</a> * pInput, GSuint uiNumInput,
|
||||
00161 <a class="code" href="group__group__RAECB.html#a0">RemoteAlgorithm_OutputCB</a> fOutput,
|
||||
00162 GSvoid * pData, GSuint & uiRequest);
|
||||
00163
|
||||
00164 <span class="keyword">private</span>:
|
||||
00165 CGLClientLIB *m_pClientLIB;
|
||||
00166
|
||||
00167 };
|
||||
00168
|
||||
00169 <span class="preprocessor">#endif //_GSCLIENCLASS_H_</span>
|
||||
</pre></div><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>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,665 @@
|
||||
<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>GSClientLibrary.h File Reference</h1>Available functions for basic ubi.com services usage.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSErrors.h"</code><br>
|
||||
<code>#include "<a class="el" href="GSLoginCB_8h-source.html">GSLoginCB.h</a>"</code><br>
|
||||
<code>#include "<a class="el" href="GSFriendsCB_8h-source.html">GSFriendsCB.h</a>"</code><br>
|
||||
<code>#include "<a class="el" href="GSLobbyCB_8h-source.html">GSLobbyCB.h</a>"</code><br>
|
||||
<code>#include "<a class="el" href="GSPersistentCB_8h-source.html">GSPersistentCB.h</a>"</code><br>
|
||||
<code>#include "<a class="el" href="GSLadderQueryCB_8h-source.html">GSLadderQueryCB.h</a>"</code><br>
|
||||
<code>#include "GSRemoteAlgorithmCB.h"</code><br>
|
||||
<code>#include "<a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a>"</code><br>
|
||||
<code>#include "RemoteAlgorithmDefines.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSClientLibrary_8h-source.html">Go to the source code of this file.</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="GSClientLibrary_8h.html#a0">GSClientLibrary_Initialize</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialisation function for the client library. </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="GSClientLibrary_8h.html#a1">GSClientLibrary_Uninitialize</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free memory. </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="GSClientLibrary_8h.html#a2">GSGetLocalIPAddress</a> (GSchar *szIPAddress)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get local ip address of the client. </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#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#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="group__group1__1.html#a11"></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__2.html#a0">LoginFix_PlayerInfo</a> (<a class="el" href="GSLoginCB_8h.html#a0">CBLoginRcv_PlayerInfo</a> fPlayerInfo)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a1">LoginFix_JoinWaitModuleResult</a> (<a class="el" href="GSLoginCB_8h.html#a1">CBLoginRcv_JoinWaitModuleResult</a> fJoinWaitModuleResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a2">LoginFix_LoginRouterResult</a> (<a class="el" href="GSLoginCB_8h.html#a2">CBLoginRcv_LoginRouterResult</a> fLoginRouterResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a3">LoginFix_LoginWaitModuleResult</a> (<a class="el" href="GSLoginCB_8h.html#a3">CBLoginRcv_LoginWaitModuleResult</a> fLoginWaitModuleResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a4">LoginFix_SystemPage</a> (<a class="el" href="GSLoginCB_8h.html#a4">CBLoginRcv_SystemPage</a> fSystemPage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a5">LoginFix_LoginDisconnection</a> (<a class="el" href="GSLoginCB_8h.html#a5">CBLoginRcv_LoginDisconnection</a> fLoginDisconnection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a6">LoginFix_LoginAccountCreationResult</a> (<a class="el" href="GSLoginCB_8h.html#a6">CBLoginRcv_AccountCreationResult</a> fLoginCreateAccount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a7">LoginFix_ModifyUserResult</a> (<a class="el" href="GSLoginCB_8h.html#a7">CBLoginRcv_ModifyUserResult</a> fLoginModifyUser)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__2.html#a8">LoginFix_RequestMOTD</a> (<a class="el" href="GSLoginCB_8h.html#a8">CBLoginRcv_RequestMOTD</a> fRequestMOTD)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group1__2.html#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__group2__1.html#a0">Friends_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 friend service. </em> <a href="group__group2__1.html#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__group2__1.html#a1">FriendsSend_Connect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is deprecated. </em> <a href="group__group2__1.html#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__group2__1.html#a2">FriendsSend_Disconnect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the friends service. </em> <a href="group__group2__1.html#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__group2__1.html#a3">FriendsSend_Login</a> (GSint lStatus=0, GSint lMood=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Log into the friends service. </em> <a href="group__group2__1.html#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__group2__1.html#a4">FriendsSend_AddFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new friend. </em> <a href="group__group2__1.html#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__group2__1.html#a5">FriendsSend_DelFriend</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a friend from friend list. </em> <a href="group__group2__1.html#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__group2__1.html#a6">FriendsSend_FriendList</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all friends in friend list. </em> <a href="group__group2__1.html#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds someone to the player's ignore-list. </em> <a href="group__group2__1.html#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes someone to the player's ignore-list. </em> <a href="group__group2__1.html#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ignore-list of the player. </em> <a href="group__group2__1.html#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__group2__1.html#a10">FriendsSend_PagePlayer</a> (const GSchar *szUsername, const GSchar *szMessage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a page to a friend. </em> <a href="group__group2__1.html#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__group2__1.html#a11">FriendsSend_PeerPlayer</a> (const GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send data to a friend. </em> <a href="group__group2__1.html#a11"></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__group2__1.html#a12">FriendsSend_StatusChange</a> (GSint iStatus, GSint iMood)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the player status. </em> <a href="group__group2__1.html#a12"></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__group2__1.html#a13">FriendsSend_ChangeFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change friend properties. </em> <a href="group__group2__1.html#a13"></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__group2__1.html#a14">FriendsSend_SearchPlayer</a> (const GSchar *szUsername, const GSchar *szSurName, const GSchar *szFirstName, const GSchar *szCountry, const GSchar *szEmail, GSint iSex, const GSchar *szGame)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for a player. </em> <a href="group__group2__1.html#a14"></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__group2__1.html#a15">FriendsSend_GetPlayerScores</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get player score. </em> <a href="group__group2__1.html#a15"></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__group2__2.html#a0">FriendsFix_LoginResult</a> (<a class="el" href="GSFriendsCB_8h.html#a0">CBFriendsRcv_LoginResult</a> fLoginResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a1">FriendsFix_AddFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a1">CBFriendsRcv_AddFriend</a> fAddFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a2">FriendsFix_DelFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a2">CBFriendsRcv_DelFriend</a> fDelFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a2"></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__group2__2.html#a3">FriendsFix_IgnorePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a3">CBFriendsRcv_IgnorePlayer</a> fIgnorePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a3"></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__group2__2.html#a4">FriendsFix_UnignorePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a4">CBFriendsRcv_UnignorePlayer</a> fUnignorePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a4"></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__group2__2.html#a5">FriendsFix_ListIgnoredPlayers</a> (<a class="el" href="GSFriendsCB_8h.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> fListIgnoredPlayers)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a5"></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__group2__2.html#a6">FriendsFix_IgnoredPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a6">CBFriendsRcv_IgnoredPlayer</a> fIgnoredPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a7">FriendsFix_Page</a> (<a class="el" href="GSFriendsCB_8h.html#a7">CBFriendsRcv_Page</a> fPage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a8">FriendsFix_PagePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a8">CBFriendsRcv_PagePlayer</a> fPagePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a9">FriendsFix_PeerMsg</a> (<a class="el" href="GSFriendsCB_8h.html#a9">CBFriendsRcv_PeerMsg</a> fPeerMsg)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a10">FriendsFix_PeerPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a10">CBFriendsRcv_PeerPlayer</a> fPeerPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#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__group2__2.html#a11">FriendsFix_StatusChange</a> (<a class="el" href="GSFriendsCB_8h.html#a12">CBFriendsRcv_StatusChange</a> fStatusChange)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a11"></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__group2__2.html#a12">FriendsFix_ChangeFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a11">CBFriendsRcv_ChangeFriend</a> fChangeFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a12"></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__group2__2.html#a13">FriendsFix_UpdateFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a13">CBFriendsRcv_UpdateFriend</a> fUpdateFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a13"></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__group2__2.html#a14">FriendsFix_SearchPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a14">CBFriendsRcv_SearchPlayer</a> fSearchPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a14"></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__group2__2.html#a15">FriendsFix_ScoreCard</a> (<a class="el" href="GSFriendsCB_8h.html#a15">CBFriendsRcv_ScoreCard</a> fScoreCard)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group2__2.html#a15"></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__group4__1.html#a0">Lobby_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 lobby service. </em> <a href="group__group4__1.html#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__group4__1.html#a1">LobbySend_Connect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is deprecated. </em> <a href="group__group4__1.html#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__group4__1.html#a2">LobbySend_Disconnect</a> (GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the lobby server. </em> <a href="group__group4__1.html#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__group4__1.html#a3">LobbySend_DisconnectAll</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the lobby server. </em> <a href="group__group4__1.html#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__group4__1.html#a4">LobbySend_Login</a> (const GSchar *szGames, GSbool bPublicIP=GS_TRUE, GSushort usPlayerStatus=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used to log into the lobby service. </em> <a href="group__group4__1.html#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__group4__1.html#a5">LobbySend_JoinLobby</a> (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSint iconfig=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join a lobby. </em> <a href="group__group4__1.html#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__group4__1.html#a6">LobbySend_JoinRoom</a> (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSbool bVisitor, const GSchar *szVersion, GSint iconfig=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join a room. </em> <a href="group__group4__1.html#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__group4__1.html#a7">LobbySend_LeaveGroup</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave a group. </em> <a href="group__group4__1.html#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__group4__1.html#a8">LobbySend_CreateRoom</a> (GSint iParentGroupID, GSint iLobbyServerID, const GSchar *szRoomName, const GSchar *szGames, GSushort usRoomType, GSushort usMaxPlayers, GSushort usMaxVisitors, const GSvoid *vpData, GSint iSize, const GSvoid *vpAltGroupInfo, GSint iAltGroupInfoSize, const GSchar *szPassword, const GSchar *szGameVersion, const GSchar *szGSVersion)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a room. </em> <a href="group__group4__1.html#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__group4__1.html#a9">LobbySend_StartMatch</a> (GSint iGroupID, GSint iLobbyServerID, GSuint uiMode=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are ready to start the match. </em> <a href="group__group4__1.html#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__group4__1.html#a10">LobbySend_MatchFinish</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are finishing the match. </em> <a href="group__group4__1.html#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__group4__1.html#a11">LobbySend_NewMaster</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are ready to start the match. </em> <a href="group__group4__1.html#a11"></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__group4__1.html#a12">LobbySend_PlayerMatchStarted</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that a match is finished. </em> <a href="group__group4__1.html#a12"></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__group4__1.html#a13">LobbySend_PlayerMatchFinished</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that a match is finished. </em> <a href="group__group4__1.html#a13"></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__group4__1.html#a14">LobbySend_PlayerKick</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that to kick a player. </em> <a href="group__group4__1.html#a14"></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__group4__1.html#a15">LobbySend_GetParentGroupID</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that to get a parent group id. </em> <a href="group__group4__1.html#a15"></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__group4__1.html#a16">LobbySend_UpdateRoomConfig</a> (GSint iGroupID, GSint iLobbyServerID, GSbyte bDedicatedServer, GSbyte bOpen, GSbyte bScore_Submission, GSint iMaxPlayers, GSint iMaxVisitors, const GSchar *szPassword, const GSvoid *vpGroupInfo, GSint iGroupInfoSize, const GSvoid *vpAltGroupInfo, GSint iAltGroupInfoSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server to update room configuration flags. </em> <a href="group__group4__1.html#a16"></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__group4__1.html#a17">LobbySend_GetGroupInfo</a> (GSint iGroupID, GSint iLobbyServerID, GSint iconfig)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get information about a group. </em> <a href="group__group4__1.html#a17"></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__group4__1.html#a18">LobbySend_GetAlternateGroupInfo</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get information about a group. </em> <a href="group__group4__1.html#a18"></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__group4__1.html#a19">LobbySend_InitMatchResults</a> (GSuint uiMatchID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the library score submission system. </em> <a href="group__group4__1.html#a19"></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__group4__1.html#a20">LobbySend_SetMatchResult</a> (const GSchar *szUserName, GSuint uiFieldID, GSint iFieldValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set results for a player in a match. </em> <a href="group__group4__1.html#a20"></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__group4__1.html#a21">LobbySend_SubmitMatchResult</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the compiled scores of a match to the lobby server. </em> <a href="group__group4__1.html#a21"></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__group4__1.html#a22">LobbySend_ClearMatchResult</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unload the internal score submission system. </em> <a href="group__group4__1.html#a22"></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__group4__1.html#a23">LobbySend_UpdatePing</a> (GSint iGroupID, GSint iLobbyServerID, GSushort usPing)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a new ping value to the server. </em> <a href="group__group4__1.html#a23"></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__group4__1.html#a24">LobbySend_GameStart</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server that the game is started. </em> <a href="group__group4__1.html#a24"></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__group4__1.html#a25">LobbySend_GameConnected</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server that you are connected. </em> <a href="group__group4__1.html#a25"></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__group4__1.html#a26">LobbySend_GameFinish</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server about the end of the game. </em> <a href="group__group4__1.html#a26"></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__group4__1.html#a27">LobbySend_GameReady</a> (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server about connection readiness. </em> <a href="group__group4__1.html#a27"></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__group4__1.html#a28">LobbySend_UpdateGameInfo</a> (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server about new game information. </em> <a href="group__group4__1.html#a28"></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__group4__1.html#a29">LobbySend_PlayerBan</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ban a player from a group. </em> <a href="group__group4__1.html#a29"></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__group4__1.html#a30">LobbySend_PlayerUnBan</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-Ban a player from a group. </em> <a href="group__group4__1.html#a30"></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__group4__1.html#a31">LobbySend_GetPlayerBannedList</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get banned player list. </em> <a href="group__group4__1.html#a31"></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__group4__1.html#a32">LobbySend_SetPlayerInfo</a> (GSvoid *vpPlayerInfo, GSint iPlayerInfoSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set player specific information. </em> <a href="group__group4__1.html#a32"></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__group4__1.html#a33">LobbySend_GetPlayerGroups</a> (GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set player specific information. </em> <a href="group__group4__1.html#a33"></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__group4__1.html#a34">LobbySend_ChangeRequestedLobbies</a> (const GSchar *szGames)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used to get a new list of available lobbies for a game. </em> <a href="group__group4__1.html#a34"></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__group4__2.html#a0">LobbyFix_LoginReply</a> (<a class="el" href="GSLobbyCB_8h.html#a0">CBLobbyRcv_LoginReply</a> fLoginReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for te callback. </em> <a href="group__group4__2.html#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__group4__2.html#a1">LobbyFix_LobbyDisconnection</a> (<a class="el" href="GSLobbyCB_8h.html#a1">CBLobbyRcv_LobbyDisconnection</a> fLobbyDisconnection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a2">LobbyFix_LobbyDisconnectAll</a> (<a class="el" href="GSLobbyCB_8h.html#a2">CBLobbyRcv_LobbyDisconnectAll</a> fLobbyDisconnectAll)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a3">LobbyFix_CreateRoomReply</a> (<a class="el" href="GSLobbyCB_8h.html#a3">CBLobbyRcv_CreateRoomReply</a> fCreateRoomReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a4">LobbyFix_NewRoom</a> (<a class="el" href="GSLobbyCB_8h.html#a4">CBLobbyRcv_NewRoom</a> fNewRoom)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a5">LobbyFix_NewLobby</a> (<a class="el" href="GSLobbyCB_8h.html#a5">CBLobbyRcv_NewLobby</a> fNewLobby)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a6">LobbyFix_RoomInfo</a> (<a class="el" href="GSLobbyCB_8h.html#a6">CBLobbyRcv_RoomInfo</a> fRoomInfo)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a7">LobbyFix_LobbyInfo</a> (<a class="el" href="GSLobbyCB_8h.html#a7">CBLobbyRcv_LobbyInfo</a> fLobbyInfo)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a8">LobbyFix_GroupInfoGet</a> (<a class="el" href="GSLobbyCB_8h.html#a8">CBLobbyRcv_GroupInfoGet</a> fGroupInfoGet)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a9">LobbyFix_JoinRoomReply</a> (<a class="el" href="GSLobbyCB_8h.html#a10">CBLobbyRcv_JoinRoomReply</a> fJoinRoomReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a10">LobbyFix_JoinLobbyReply</a> (<a class="el" href="GSLobbyCB_8h.html#a11">CBLobbyRcv_JoinLobbyReply</a> fJoinLobbyReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#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__group4__2.html#a11">LobbyFix_MemberJoined</a> (<a class="el" href="GSLobbyCB_8h.html#a12">CBLobbyRcv_MemberJoined</a> fMemberJoined)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a11"></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__group4__2.html#a12">LobbyFix_MemberLeave</a> (<a class="el" href="GSLobbyCB_8h.html#a13">CBLobbyRcv_MemberLeave</a> fMemberLeave)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a12"></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__group4__2.html#a13">LobbyFix_StartMatchReply</a> (<a class="el" href="GSLobbyCB_8h.html#a14">CBLobbyRcv_StartMatchReply</a> fStartMatchReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a13"></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__group4__2.html#a14">LobbyFix_GroupRemove</a> (<a class="el" href="GSLobbyCB_8h.html#a9">CBLobbyRcv_GroupRemove</a> fGroupRemove)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a14"></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__group4__2.html#a15">LobbyFix_MasterNewReply</a> (<a class="el" href="GSLobbyCB_8h.html#a16">CBLobbyRcv_MasterNewReply</a> fMasterNewReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a15"></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__group4__2.html#a16">LobbyFix_MasterChanged</a> (<a class="el" href="GSLobbyCB_8h.html#a15">CBLobbyRcv_MasterChanged</a> fMasterChanged)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a16"></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__group4__2.html#a17">LobbyFix_MatchFinishReply</a> (<a class="el" href="GSLobbyCB_8h.html#a17">CBLobbyRcv_MatchFinishReply</a> fMatchFinishReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a17"></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__group4__2.html#a18">LobbyFix_PlayerKickReply</a> (<a class="el" href="GSLobbyCB_8h.html#a18">CBLobbyRcv_PlayerKickReply</a> fPlayerKickReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a18"></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__group4__2.html#a19">LobbyFix_KickOut</a> (<a class="el" href="GSLobbyCB_8h.html#a19">CBLobbyRcv_KickOut</a> fKickOut)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a19"></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__group4__2.html#a20">LobbyFix_ParentGroupIDReply</a> (<a class="el" href="GSLobbyCB_8h.html#a20">CBLobbyRcv_ParentGroupIDReply</a> fParentGroupIDReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a20"></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__group4__2.html#a21">LobbyFix_GetAlternateGroupInfoReply</a> (<a class="el" href="GSLobbyCB_8h.html#a21">CBLobbyRcv_GetAlternateGroupInfoReply</a> fGetAlternateGroupInfoReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a21"></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__group4__2.html#a22">LobbyFix_GroupLeaveReply</a> (<a class="el" href="GSLobbyCB_8h.html#a22">CBLobbyRcv_GroupLeaveReply</a> fGroupLeaveReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a22"></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__group4__2.html#a23">LobbyFix_GroupConfigUpdate</a> (<a class="el" href="GSLobbyCB_8h.html#a23">CBLobbyRcv_GroupConfigUpdate</a> fGroupConfigUpdate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a23"></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__group4__2.html#a24">LobbyFix_MatchStarted</a> (<a class="el" href="GSLobbyCB_8h.html#a24">CBLobbyRcv_MatchStarted</a> fMatchStarted)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a24"></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__group4__2.html#a25">LobbyFix_UpdateRoomConfigReply</a> (<a class="el" href="GSLobbyCB_8h.html#a25">CBLobbyRcv_UpdateRoomConfigReply</a> fUpdateRoomConfigReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a25"></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__group4__2.html#a26">LobbyFix_SubmitMatchResultReply</a> (<a class="el" href="GSLobbyCB_8h.html#a26">CBLobbyRcv_SubmitMatchResultReply</a> fSubmitMatchResultReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a26"></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__group4__2.html#a27">LobbyFix_UpdatePing</a> (<a class="el" href="GSLobbyCB_8h.html#a27">CBLobbyRcv_UpdatePing</a> fUpdatePing)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a27"></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__group4__2.html#a28">LobbyFix_GameStartReply</a> (<a class="el" href="GSLobbyCB_8h.html#a28">CBLobbyRcv_StartGameReply</a> fStartGameReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a28"></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__group4__2.html#a29">LobbyFix_GameReadyReply</a> (<a class="el" href="GSLobbyCB_8h.html#a29">CBLobbyRcv_GameReadyReply</a> fGameReadyReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a29"></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__group4__2.html#a30">LobbyFix_GameStarted</a> (<a class="el" href="GSLobbyCB_8h.html#a30">CBLobbyRcv_GameStarted</a> fGameStarted)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a30"></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__group4__2.html#a31">LobbyFix_NewGameMember</a> (<a class="el" href="GSLobbyCB_8h.html#a31">CBLobbyRcv_NewGameMember</a> fNewGameMember)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a31"></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__group4__2.html#a32">LobbyFix_UpdateGameInfoReply</a> (<a class="el" href="GSLobbyCB_8h.html#a32">CBLobbyRcv_UpdateGameInfoReply</a> fUpdateGameInfoReplyCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a32"></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__group4__2.html#a33">LobbyFix_PlayerBanReply</a> (<a class="el" href="GSLobbyCB_8h.html#a33">CBLobbyRcv_PlayerBanReply</a> fPlayerBanReplyCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a33"></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__group4__2.html#a34">LobbyFix_PlayerUnBanReply</a> (<a class="el" href="GSLobbyCB_8h.html#a34">CBLobbyRcv_PlayerUnBanReply</a> fPlayerUnBanReplyCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a34"></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__group4__2.html#a35">LobbyFix_PlayerBanList</a> (<a class="el" href="GSLobbyCB_8h.html#a35">CBLobbyRcv_PlayerBanList</a> fPlayerBanListCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a35"></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__group4__2.html#a36">LobbyFix_PlayerBanned</a> (<a class="el" href="GSLobbyCB_8h.html#a36">CBLobbyRcv_PlayerBanned</a> fPlayerBannedCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a36"></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__group4__2.html#a37">LobbyFix_MatchReady</a> (<a class="el" href="GSLobbyCB_8h.html#a37">CBLobbyRcv_MatchReady</a> fMatchReadyCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a37"></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__group4__2.html#a38">LobbyFix_InfoRefresh</a> (<a class="el" href="GSLobbyCB_8h.html#a38">CBLobbyRcv_InfoRefresh</a> fInfoRefresh)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a38"></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__group4__2.html#a39">LobbyFix_SetPlayerInfoReply</a> (<a class="el" href="GSLobbyCB_8h.html#a39">CBLobbyRcv_SetPlayerInfoReply</a> fSetPlayerInfoReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a39"></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__group4__2.html#a40">LobbyFix_PlayerInfoUpdate</a> (<a class="el" href="GSLobbyCB_8h.html#a40">CBLobbyRcv_PlayerInfoUpdate</a> fPlayerInfoUpdate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a40"></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__group4__2.html#a41">LobbyFix_PlayerGroupList</a> (<a class="el" href="GSLobbyCB_8h.html#a42">CBLobbyRcv_PlayerGroupList</a> fPlayerGroupListCB)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a41"></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__group4__2.html#a42">LobbyFix_PlayerStatusUpdate</a> (<a class="el" href="GSLobbyCB_8h.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> fPlayerStatusUpdate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group4__2.html#a42"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a43" doxytag="GSClientLibrary.h::LobbyFix_FinalMatchResults" ></a>
|
||||
GSbool </td><td class="memItemRight" valign=bottom><b>LobbyFix_FinalMatchResults</b> (<a class="el" href="GSLobbyCB_8h.html#a43">CBLobbyRcv_FinalMatchResults</a> fFinalMatchResults)</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a0">PSSend_Login</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Login to the persistent storage service. </em> <a href="group__group5__1.html#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__group5__1.html#a1">PSSend_Disconnect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the persistent storage service. </em> <a href="group__group5__1.html#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__group5__1.html#a2">PS_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 persistent data storage service. </em> <a href="group__group5__1.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a3">PSSend_GetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the private data related to a player. </em> <a href="group__group5__1.html#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a4">PSSend_SetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the private data related to a player. </em> <a href="group__group5__1.html#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a5">PSSend_GetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSchar *szUsername=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the public data related to a player. </em> <a href="group__group5__1.html#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a6">PSSend_SetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the public data related to a player. </em> <a href="group__group5__1.html#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__group5__2.html#a0">PSFix_LoginResult</a> (<a class="el" href="GSPersistentCB_8h.html#a0">CBPSRcv_LoginResult</a> fPSLoginResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group5__2.html#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__group5__2.html#a1">PSFix_Disconnection</a> (<a class="el" href="GSPersistentCB_8h.html#a1">CBPSRcv_Disconnection</a> fPSDisconnection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group5__2.html#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__group5__2.html#a2">PSFix_SetDataReply</a> (<a class="el" href="GSPersistentCB_8h.html#a2">CBPSRcv_SetDataReply</a> fSetDataReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group5__2.html#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__group5__2.html#a3">PSFix_GetDataReply</a> (<a class="el" href="GSPersistentCB_8h.html#a3">CBPSRcv_GetDataReply</a> fGetDataReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group5__2.html#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__group6__1.html#a0">LadderQuery_Initialize</a> (GSchar *szLocale)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the ladder query service. </em> <a href="group__group6__1.html#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__group6__1.html#a1">LadderQuery_Uninitialize</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialization function for the ladder query service. </em> <a href="group__group6__1.html#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__group6__1.html#a2">LadderQuery_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status related to the ladder query service. </em> <a href="group__group6__1.html#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__group6__1.html#a3">LadderQuery_CreateRequest</a> (GSchar *szGameName, GSuint uiEvent=0, GSuint uiMode=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a basic ladder query request. </em> <a href="group__group6__1.html#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a4">LadderQuery_SendRequest</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a request over the network. </em> <a href="group__group6__1.html#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__group6__1.html#a5">LadderQuery_RequestPivotUser</a> (const GSchar *pszEntry, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (username). </em> <a href="group__group6__1.html#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__group6__1.html#a6">LadderQuery_RequestPivotRow</a> (GSuint uiRowNumber, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (row number). </em> <a href="group__group6__1.html#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__group6__1.html#a7">LadderQuery_RequestSet</a> (const GSchar *pszEntries[], GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting a pre-defined set of entries. </em> <a href="group__group6__1.html#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__group6__1.html#a8">LadderQuery_RequestOrderedList</a> (GSuint uiFirstEntry, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries from a starting index (row number). </em> <a href="group__group6__1.html#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__group6__1.html#a9">LadderQuery_AddSortConstraint</a> (const GSchar *pszField, GSbool bSortDirection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>sort</b> constraint to a created request. </em> <a href="group__group6__1.html#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__group6__1.html#a10">LadderQuery_AddFilterConstraint</a> (const <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> *pLadderFilter[], GSuint uiListOfFilters)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>filter</b> constraint to a created request. </em> <a href="group__group6__1.html#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__group6__1.html#a11">LadderQuery_AddDisplayConstraint</a> (const GSchar *pszFields[], GSuint uiNumberOfFields)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>display</b> constraint to a created request. </em> <a href="group__group6__1.html#a11"></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__group6__2.html#a0">LadderQuery_GetResultSearchCount</a> (GSuint uiRequestID, GSuint &uiCount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the request search count. </em> <a href="group__group6__2.html#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__group6__2.html#a1">LadderQuery_GetResultEntryCount</a> (GSuint uiRequestID, GSuint &uiCount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the request entry count. </em> <a href="group__group6__2.html#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__group6__2.html#a2">LadderQuery_GetResultFieldCaption</a> (GSuint uiRequestID, const GSchar *pszField, GSchar *pszCaption)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pretty name of a field. </em> <a href="group__group6__2.html#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__group6__2.html#a3">LadderQuery_StartResultEntryEnumeration</a> (GSuint uiRequestID, GSuint uiStartEntry=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the entry enumeration. </em> <a href="group__group6__2.html#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__group6__2.html#a4">LadderQuery_NextResultEntry</a> (GSuint uiRequestID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the results set pointer to the next entry (iteration). </em> <a href="group__group6__2.html#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__group6__2.html#a5">LadderQuery_GetCurrentEntryField</a> (GSuint uiRequestID, const GSchar *pszField, GSint &iValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current numeric field value. </em> <a href="group__group6__2.html#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__group6__2.html#a6">LadderQuery_GetCurrentEntryFieldAsString</a> (GSuint uiRequestID, const GSchar *pszField, GSchar *pszValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current field value in a string format. </em> <a href="group__group6__2.html#a6"></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__group6__2.html#a7">LadderQuery_ReleaseResult</a> (GSuint uiRequestID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the results set from memory. </em> <a href="group__group6__2.html#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__group6__3.html#a0">LadderQueryFix_RequestReply</a> (<a class="el" href="GSLadderQueryCB_8h.html#a0">CBLadderQueryRcv_RequestReply</a> fQueryReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="group__group6__3.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise</a> (const GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises the resources required by the service. </em> <a href="group__group7__1.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a1">RemoteAlgorithm_Uninitialise</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the resources acquired by the service. </em> <a href="group__group7__1.html#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a2">RemoteAlgorithm_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxOperationalDelay=800)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs the service. </em> <a href="group__group7__1.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a3">RemoteAlgorithm_Execute</a> (GSuint uiAlgoId, const <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a> *pInput, GSuint uiNumInput, const <a class="el" href="GSRemoteAlgorithmCB_8h.html#a0">RemoteAlgorithm_OutputCB</a> fOutput, const GSvoid *pData, GSuint &uiRequestId)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requests the execution of an algorithm. </em> <a href="group__group7__1.html#a3"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>This file provide all the methods that allow developers to use the basic ubi.com services.</dd></dl>
|
||||
<hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::GSClientLibrary_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"> GSbool GSClientLibrary_Initialize </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>Initialize the communication ressources. Must be call prior to any other functions.</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>Initialisation was successfull </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Initialisation failed </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::GSClientLibrary_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"> GSbool GSClientLibrary_Uninitialize </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 free memory that as been allocated by the library. Call this when you're done using the library, use in pair with GSClientLibrary_Initialize.</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>Library deallocation was successfull </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Library deallocation failed </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::GSGetLocalIPAddress" ></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 GSGetLocalIPAddress </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szIPAddress</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 retrieves the local ip address of the client. Should only be called when the connection to the server is open, otherwise it will return GS_FALSE.</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>IP address detection successfull </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>IP address detection 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>szIPAddress</em> </td><td>Character string that contains the ip address </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>
|
||||
@@ -0,0 +1,166 @@
|
||||
<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>GSFriendsCB.h</h1><a href="GSFriendsCB_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">//****************************************************************************</span>
|
||||
00002 <span class="comment">//* Author: Guillaume Plante <gsdevteam@ubisoft.com></span>
|
||||
00003 <span class="comment">//* Date: 5/16/01 9:43:49 AM</span>
|
||||
00010 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00011
|
||||
00012
|
||||
00013 <span class="preprocessor">#ifndef _GSFRIENDSCB_H_</span>
|
||||
00014 <span class="preprocessor"></span><span class="preprocessor">#define _GSFRIENDSCB_H_</span>
|
||||
00015 <span class="preprocessor"></span>
|
||||
00016 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00017 <span class="preprocessor">#include "GSErrors.h"</span>
|
||||
00018
|
||||
00019 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
00020 <span class="preprocessor"></span><span class="keyword">class </span>clFriendsCallbacks
|
||||
00021 {
|
||||
00022 <span class="keyword">public</span>:
|
||||
00023 <span class="keyword">virtual</span> GSvoid FriendsRcv_LoginResult(GSubyte ubType, GSint iReason) = 0;
|
||||
00024 <span class="keyword">virtual</span> GSvoid FriendsRcv_AddFriend(GSubyte ubType, GSint iReason,
|
||||
00025 GSchar* szFriend) = 0;
|
||||
00026 <span class="keyword">virtual</span> GSvoid FriendsRcv_DelFriend(GSubyte ubType, GSint iReason,
|
||||
00027 GSchar* szFriend) = 0;
|
||||
00028 <span class="keyword">virtual</span> GSvoid FriendsRcv_IgnorePlayer( GSRESULT rCode,
|
||||
00029 <span class="keyword">const</span> GSchar * szPlayer ) = 0;
|
||||
00030 <span class="keyword">virtual</span> GSvoid FriendsRcv_UnignorePlayer( GSRESULT rCode,
|
||||
00031 <span class="keyword">const</span> GSchar * szPlayer ) = 0;
|
||||
00032 <span class="keyword">virtual</span> GSvoid FriendsRcv_ListIgnoredPlayers( GSRESULT rCode ) = 0;
|
||||
00033 <span class="keyword">virtual</span> GSvoid FriendsRcv_IgnoredPlayer( <span class="keyword">const</span> GSchar * szPlayer ) = 0;
|
||||
00034 <span class="keyword">virtual</span> GSvoid FriendsRcv_Page(GSchar* szUsername, GSchar* szMessage,
|
||||
00035 GSchar* szTimeStamp) = 0;
|
||||
00036 <span class="keyword">virtual</span> GSvoid FriendsRcv_PagePlayer(GSubyte ubType, GSint iReason,
|
||||
00037 GSchar* szUsername) = 0;
|
||||
00038 <span class="keyword">virtual</span> GSvoid FriendsRcv_PeerMsg(GSchar* szUsername, GSvoid* p_Buffer,
|
||||
00039 GSuint uiLength) = 0;
|
||||
00040 <span class="keyword">virtual</span> GSvoid FriendsRcv_PeerPlayer(GSubyte ubType, GSint iReason,
|
||||
00041 GSchar* szUsername) = 0;
|
||||
00042 <span class="keyword">virtual</span> GSvoid FriendsRcv_ChangeFriend(GSubyte ubType, GSint iReason) = 0;
|
||||
00043 <span class="keyword">virtual</span> GSvoid FriendsRcv_StatusChange(GSubyte ubType, GSint iReason) = 0;
|
||||
00044 <span class="keyword">virtual</span> GSvoid FriendsRcv_UpdateFriend(GSchar* szUsername, GSint iReason,
|
||||
00045 GSchar* szGroup, GSint iMood, GSint iOptions, GSchar *szGameName) = 0;
|
||||
00046 <span class="keyword">virtual</span> GSvoid FriendsRcv_SearchPlayer(GSubyte ubType, GSint iReason,
|
||||
00047 GSchar* szUsername, GSint iStatus, GSchar *szGameName) = 0;
|
||||
00048 <span class="keyword">virtual</span> GSvoid FriendsRcv_ScoreCard(GSubyte ubType, GSint iReason,
|
||||
00049 GSchar* szPlayer,GSchar* szGame, GSchar* szScore) = 0;
|
||||
00050 };
|
||||
00051 <span class="preprocessor">#endif //__cplusplus</span>
|
||||
00052 <span class="preprocessor"></span>
|
||||
00053
|
||||
00058 <span class="comment">//============================================================================</span>
|
||||
00059 <span class="comment">// Callback CBFriendsRcv_LoginResult</span>
|
||||
00073 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00074"></a><a class="code" href="group__group__FriendCB.html#a0">00074</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult</a>)(GSubyte ubType,
|
||||
00075 GSint iReason);
|
||||
00076
|
||||
00077 <span class="comment">//============================================================================</span>
|
||||
00078 <span class="comment">// Callback CBFriendsRcv_AddFriend</span>
|
||||
00097 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00098"></a><a class="code" href="group__group__FriendCB.html#a1">00098</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend</a>)(GSubyte ubType,
|
||||
00099 GSint iReason, GSchar* szUsername);
|
||||
00100
|
||||
00101 <span class="comment">//============================================================================</span>
|
||||
00102 <span class="comment">// Callback CBFriendsRcv_DelFriend</span>
|
||||
00117 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00118"></a><a class="code" href="group__group__FriendCB.html#a2">00118</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</a>)(GSubyte ubType,
|
||||
00119 GSint iReason, GSchar* szUsername);
|
||||
00120
|
||||
00121 <span class="comment">//============================================================================</span>
|
||||
00122 <span class="comment">// Callback CBFriendsRcv_IgnorePlayer</span>
|
||||
00123
|
||||
00148 <span class="comment">//============================================================================</span>
|
||||
<a name="l00149"></a><a class="code" href="group__group__FriendCB.html#a3">00149</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer</a>)( GSRESULT rCode,
|
||||
00150 <span class="keyword">const</span> GSchar * szPlayer );
|
||||
00151
|
||||
00152 <span class="comment">//============================================================================</span>
|
||||
00153 <span class="comment">// Callback CBFriendsRcv_UnignorePlayer</span>
|
||||
00154
|
||||
00178 <span class="comment">//============================================================================</span>
|
||||
<a name="l00179"></a><a class="code" href="group__group__FriendCB.html#a4">00179</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer</a>)(
|
||||
00180 GSRESULT rCode, <span class="keyword">const</span> GSchar * szPlayer );
|
||||
00181
|
||||
00182 <span class="comment">//============================================================================</span>
|
||||
00183 <span class="comment">// Callback CBFriendsRcv_ListIgnoredPlayers</span>
|
||||
00184
|
||||
00206 <span class="comment">//============================================================================</span>
|
||||
<a name="l00207"></a><a class="code" href="group__group__FriendCB.html#a5">00207</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers</a>)( GSRESULT rCode );
|
||||
00208
|
||||
00209 <span class="comment">//============================================================================</span>
|
||||
00210 <span class="comment">// Callback CBFriendsRcv_IgnoredPlayer</span>
|
||||
00211
|
||||
00224 <span class="comment">//============================================================================</span>
|
||||
<a name="l00225"></a><a class="code" href="group__group__FriendCB.html#a6">00225</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer</a>)(
|
||||
00226 <span class="keyword">const</span> GSchar * szPlayer );
|
||||
00227
|
||||
00228 <span class="comment">//============================================================================</span>
|
||||
00229 <span class="comment">// Callback CBFriendsRcv_Page</span>
|
||||
00245 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00246"></a><a class="code" href="group__group__FriendCB.html#a7">00246</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a>)(GSchar* szUsername,
|
||||
00247 GSchar* pszMessage, GSchar* szTimeStamp);
|
||||
00248
|
||||
00249 <span class="comment">//============================================================================</span>
|
||||
00250 <span class="comment">// Callback CBFriendsRcv_PagePlayer</span>
|
||||
00270 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00271"></a><a class="code" href="group__group__FriendCB.html#a8">00271</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a>)(GSubyte ubType,
|
||||
00272 GSint iReason, GSchar* szUsername);
|
||||
00273
|
||||
00274 <span class="comment">//============================================================================</span>
|
||||
00275 <span class="comment">// Callback CBFriendsRcv_PeerMsg</span>
|
||||
00290 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00291"></a><a class="code" href="group__group__FriendCB.html#a9">00291</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a>)(GSchar* szUsername,
|
||||
00292 GSvoid* p_Buffer, GSuint uiLength);
|
||||
00293
|
||||
00294
|
||||
00295 <span class="comment">//============================================================================</span>
|
||||
00296 <span class="comment">// Callback CBFriendsRcv_PeerPlayer</span>
|
||||
00318 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00319"></a><a class="code" href="group__group__FriendCB.html#a10">00319</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer</a>)(GSubyte ubType,
|
||||
00320 GSint iReason, GSchar* szUsername);
|
||||
00321
|
||||
00322 <span class="comment">//============================================================================</span>
|
||||
00323 <span class="comment">// Callback CBFriendsRcv_ChangeFriend</span>
|
||||
00337 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00338"></a><a class="code" href="group__group__FriendCB.html#a11">00338</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a11">CBFriendsRcv_ChangeFriend</a>)(GSubyte ubType,
|
||||
00339 GSint iReason);
|
||||
00340
|
||||
00341 <span class="comment">//============================================================================</span>
|
||||
00342 <span class="comment">// Callback CBFriendsRcv_StatusChange</span>
|
||||
00356 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00357"></a><a class="code" href="group__group__FriendCB.html#a12">00357</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange</a>)(GSubyte ubType,
|
||||
00358 GSint iReason);
|
||||
00359
|
||||
00360 <span class="comment">//============================================================================</span>
|
||||
00361 <span class="comment">// Callback CBFriendsRcv_UpdateFriend</span>
|
||||
00382 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00383"></a><a class="code" href="group__group__FriendCB.html#a13">00383</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a>)(GSchar* szUsername,
|
||||
00384 GSint iStatus, GSchar* szGroup, GSint iMood, GSint iOptions,
|
||||
00385 GSchar *szGameName);
|
||||
00386
|
||||
00387 <span class="comment">//============================================================================</span>
|
||||
00388 <span class="comment">// Callback CBFriendsRcv_SearchPlayer</span>
|
||||
00410 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00411"></a><a class="code" href="group__group__FriendCB.html#a14">00411</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</a>)(GSubyte ubType,
|
||||
00412 GSint iReason,GSchar* szUsername, GSint iStatus, GSchar *szGameName);
|
||||
00413
|
||||
00414 <span class="comment">//============================================================================</span>
|
||||
00415 <span class="comment">// Callback CBFriendsRcv_ScoreCard</span>
|
||||
00430 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00431"></a><a class="code" href="group__group__FriendCB.html#a15">00431</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</a>)(GSubyte ubType,
|
||||
00432 GSint iReason,GSchar* szUsername,GSchar* szGame, GSchar* szScore);
|
||||
00433
|
||||
00438 <span class="preprocessor">#endif //_GSFRIENDSCB_H_</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<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>GSFriendsCB.h File Reference</h1>Callback functions for the <b><em>friends service</em></b>.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
<code>#include "GSErrors.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSFriendsCB_8h-source.html">Go to the source code of this file.</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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive friends service login result. </em> <a href="group__group__FriendCB.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the friend addition request. </em> <a href="group__group__FriendCB.html#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the remove friend request. </em> <a href="group__group__FriendCB.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer</a> )(GSRESULT rCode, const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of an ignore player request. </em> <a href="group__group__FriendCB.html#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer</a> )(GSRESULT rCode, const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of an unignore player request. </em> <a href="group__group__FriendCB.html#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> )(GSRESULT rCode)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of a request to get the ignore-list. </em> <a href="group__group__FriendCB.html#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer</a> )(const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of the ignored players. </em> <a href="group__group__FriendCB.html#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a> )(GSchar *szUsername, GSchar *pszMessage, GSchar *szTimeStamp)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a page message. </em> <a href="group__group__FriendCB.html#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of send page request. </em> <a href="group__group__FriendCB.html#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a> )(GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a peer message. </em> <a href="group__group__FriendCB.html#a9"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the send peer message request. </em> <a href="group__group__FriendCB.html#a10"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a11">CBFriendsRcv_ChangeFriend</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of change friend request. </em> <a href="group__group__FriendCB.html#a11"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of a change status request. </em> <a href="group__group__FriendCB.html#a12"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> )(GSchar *szUsername, GSint iStatus, GSchar *szGroup, GSint iMood, GSint iOptions, GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive information about a friend. </em> <a href="group__group__FriendCB.html#a13"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSint iStatus, GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of search player request. </em> <a href="group__group__FriendCB.html#a14"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSchar *szGame, GSchar *szScore)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive score card information for a player. </em> <a href="group__group__FriendCB.html#a15"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file contains all callback functions declaration for the friend service.<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>
|
||||
@@ -0,0 +1,45 @@
|
||||
<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>GSLadderQueryCB.h</h1><a href="GSLadderQueryCB_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
|
||||
00002 <span class="comment">//****************************************************************************</span>
|
||||
00003 <span class="comment">//* Author: Guillaume Plante <gsdevelopers@ubisoft.com></span>
|
||||
00004 <span class="comment">//* Date: 2003-07-14</span>
|
||||
00011 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00012
|
||||
00013 <span class="preprocessor">#ifndef __GSLADDERQUERYCB_H__</span>
|
||||
00014 <span class="preprocessor"></span><span class="preprocessor">#define __GSLADDERQUERYCB_H__</span>
|
||||
00015 <span class="preprocessor"></span>
|
||||
00016 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00017
|
||||
00018 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
00019 <span class="preprocessor"></span><span class="keyword">class </span>clLadderQueryCallbacks
|
||||
00020 {
|
||||
00021 <span class="keyword">public</span>:
|
||||
00022 <span class="keyword">virtual</span> GSvoid LadderQueryRcv_RequestReply(GSubyte ucType, GSint iReason, GSuint uiRequestId) = 0;
|
||||
00023 };
|
||||
00024
|
||||
00025 <span class="preprocessor">#endif //__cplusplus</span>
|
||||
00026 <span class="preprocessor"></span>
|
||||
00032 <span class="comment">//============================================================================</span>
|
||||
00033 <span class="comment">// Callback CBLadderQueryRcv_RequestReply </span>
|
||||
00034
|
||||
00048 <span class="comment">//============================================================================</span>
|
||||
<a name="l00049"></a><a class="code" href="group__group__LadderQuery.html#a0">00049</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a>)(GSubyte ucType, GSint iReason, GSuint uiRequestId);
|
||||
00050
|
||||
00051
|
||||
00054 <span class="preprocessor">#endif //__GSLADDERQUERYCB_H__</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,31 @@
|
||||
<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>GSLadderQueryCB.h File Reference</h1>Callback functions for the <b><em>ladder query service</em></b>.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSLadderQueryCB_8h-source.html">Go to the source code of this file.</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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a> )(GSubyte ucType, GSint iReason, GSuint uiRequestId)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the result of a ladder query to the ubi.com servers. </em> <a href="group__group__LadderQuery.html#a0"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file contains all callback functions declaration for the ladder query service.<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>
|
||||
@@ -0,0 +1,477 @@
|
||||
<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>GSLobbyCB.h</h1><a href="GSLobbyCB_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
|
||||
00002 <span class="comment">//****************************************************************************</span>
|
||||
00003 <span class="comment">//* Author: Guillaume Plante <gsdevteam@ubisoft.com></span>
|
||||
00004 <span class="comment">//* Date: 2001-09-20</span>
|
||||
00011 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00012
|
||||
00013 <span class="preprocessor">#ifndef _GSLOBBYCB_H_</span>
|
||||
00014 <span class="preprocessor"></span><span class="preprocessor">#define _GSLOBBYCB_H_</span>
|
||||
00015 <span class="preprocessor"></span>
|
||||
00016 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00017 <span class="preprocessor">#include "<a class="code" href="LadderDefines_8h.html">LadderDefines.h</a>"</span>
|
||||
00018
|
||||
00019 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
00020 <span class="preprocessor"></span><span class="keyword">class </span>clLobbyCallbacks
|
||||
00021 {
|
||||
00022 <span class="keyword">public</span>:
|
||||
00023
|
||||
00024 <span class="keyword">virtual</span> GSvoid LobbyRcv_LoginReply(GSubyte ubType, GSint iReason) = 0;
|
||||
00025 <span class="keyword">virtual</span> GSvoid LobbyRcv_LobbyDisconnection(GSint iLobbySrvID) = 0;
|
||||
00026 <span class="keyword">virtual</span> GSvoid LobbyRcv_LobbyDisconnectAll() = 0;
|
||||
00027 <span class="keyword">virtual</span> GSvoid LobbyRcv_CreateRoomReply(GSubyte ubType, GSint iReason,
|
||||
00028 GSchar *szRoom, GSint iGroupID, GSint iLobbySrvID)=0;
|
||||
00029 <span class="keyword">virtual</span> GSvoid LobbyRcv_JoinLobbyReply(GSubyte ubType, GSint iReason,
|
||||
00030 GSchar *szReason, GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00031 <span class="keyword">virtual</span> GSvoid LobbyRcv_JoinRoomReply(GSubyte ubType, GSint iReason,
|
||||
00032 GSchar *szReason, GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00033 <span class="keyword">virtual</span> GSvoid LobbyRcv_NewRoom(GSshort siGroupType, GSchar *szGroupName,
|
||||
00034 GSint iGroupID, GSint iLobbySrvID, GSint iParentID,GSint iConfig,
|
||||
00035 GSshort siGroupLevel,GSchar *szMaster, GSchar *szAllowedGames,
|
||||
00036 GSchar *szGames, GSchar *szGameVersion, GSchar *szGSVersion,
|
||||
00037 GSvoid *vpInfo, GSint iSize,GSuint uiMaxPlayer, GSuint uiNbrPlayer,
|
||||
00038 GSuint uiMaxVisitor, GSuint uiNbrVisitor, GSchar *szIPAddress,
|
||||
00039 GSchar *szAltIPAddress, GSint iEventID) = 0;
|
||||
00040 <span class="keyword">virtual</span> GSvoid LobbyRcv_NewLobby(GSshort siGroupType, GSchar *szGroupName,
|
||||
00041 GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig,
|
||||
00042 GSshort sGroupLevel, GSchar *szMaster, GSchar *szAllowedGames,
|
||||
00043 GSchar *szGames, GSvoid *vpInfo, GSint iSize, GSuint uiMaxMember,
|
||||
00044 GSuint uiNbrMember, GSint iEventID) = 0;
|
||||
00045 <span class="keyword">virtual</span> GSvoid LobbyRcv_RoomInfo(GSshort siGroupType, GSchar *szGroupName,
|
||||
00046 GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig,
|
||||
00047 GSshort sGroupLevel, GSchar *szMaster, GSchar *szAllowedGames,
|
||||
00048 GSchar *szGames, GSchar *szGameVersion, GSchar *szGSVersion,
|
||||
00049 GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer, GSuint uiNbrPlayer,
|
||||
00050 GSuint uiMaxVisitor, GSuint uiNbrVisitor, GSchar *szIPAddress,
|
||||
00051 GSchar *szAltIPAddress, GSint iEventID) = 0;
|
||||
00052 <span class="keyword">virtual</span> GSvoid LobbyRcv_LobbyInfo(GSshort siGroupType, GSchar *szGroupName,
|
||||
00053 GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig,
|
||||
00054 GSshort sGroupLevel, GSchar *szMaster, GSchar *szAllowedGames,
|
||||
00055 GSchar *szGames, GSvoid *vpInfo, GSint iSize, GSuint uiMaxMember,
|
||||
00056 GSuint uiNbrMember, GSint iEventID) = 0;
|
||||
00057
|
||||
00058 <span class="keyword">virtual</span> GSvoid LobbyRcv_GroupInfoGet(GSubyte ubType, GSint iLobbyID,
|
||||
00059 GSint iRoomID)=0;
|
||||
00060
|
||||
00061 <span class="keyword">virtual</span> GSvoid LobbyRcv_GroupRemove(GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00062
|
||||
00063 <span class="keyword">virtual</span> GSvoid LobbyRcv_MemberJoined(GSchar *szUsername, GSbool bVisitor,
|
||||
00064 GSint* piGroupID, GSushort usNbGroup, GSint iLobbySrvID,
|
||||
00065 GSchar *szIPAddress, GSchar *szAltIPAddress, GSushort usPing,
|
||||
00066 GSvoid *vpPlayerData, GSint iDataSize, GSbool bJoin,
|
||||
00067 GSushort usPlayerStatus ) = 0;
|
||||
00068 <span class="keyword">virtual</span> GSvoid LobbyRcv_MemberLeave(GSchar *szUsername, GSint iGroupID,
|
||||
00069 GSint iLobbySrvID) = 0;
|
||||
00070
|
||||
00071 <span class="keyword">virtual</span> GSvoid LobbyRcv_StartMatchReply(GSubyte ubType, GSint iReason,
|
||||
00072 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00073
|
||||
00074 <span class="keyword">virtual</span> GSvoid LobbyRcv_MasterNewReply(GSubyte ubType, GSint iReason,
|
||||
00075 GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID) = 0;
|
||||
00076 <span class="keyword">virtual</span> GSvoid LobbyRcv_MasterChanged(GSint iGroupID, GSint iLobbySrvID,
|
||||
00077 GSchar *szUsername, GSchar *szIPAddress, GSchar *szAltIPAddress) = 0;
|
||||
00078
|
||||
00079 <span class="keyword">virtual</span> GSvoid LobbyRcv_MatchFinishReply(GSubyte ubType, GSint iReason,
|
||||
00080 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00081
|
||||
00082 <span class="keyword">virtual</span> GSvoid LobbyRcv_KickOut(GSint iGroupID, GSint iLobbySrvID,
|
||||
00083 GSchar *szReason) = 0;
|
||||
00084 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerKickReply(GSubyte ubType, GSint iReason,
|
||||
00085 GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID) = 0;
|
||||
00086 <span class="keyword">virtual</span> GSvoid LobbyRcv_ParentGroupIDReply(GSubyte ubType, GSint iReason,
|
||||
00087 GSint iGroupID, GSint iLobbySrvID, GSint iParentGroupID) = 0;
|
||||
00088 <span class="keyword">virtual</span> GSvoid LobbyRcv_GetAlternateGroupInfoReply( GSubyte ubType,
|
||||
00089 GSint iReason, <span class="keyword">const</span> GSvoid* pcAltGroupInfo,
|
||||
00090 GSint iAltGroupInfoSize, GSint iGroupID, GSint iLobbyServerID ) = 0;
|
||||
00091 <span class="keyword">virtual</span> GSvoid LobbyRcv_GroupLeaveReply(GSubyte ubType, GSint iReason,
|
||||
00092 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00093 <span class="keyword">virtual</span> GSvoid LobbyRcv_GroupConfigUpdate(GSint iGroupID, GSint iLobbySrvID,
|
||||
00094 GSint iFlags) = 0;
|
||||
00095 <span class="keyword">virtual</span> GSvoid LobbyRcv_MatchStarted(GSint iGroupID, GSint iLobbyServerID,
|
||||
00096 GSuint uiMatchID) = 0;
|
||||
00097 <span class="keyword">virtual</span> GSvoid LobbyRcv_GroupConfigUpdateReply(GSubyte ubType,
|
||||
00098 GSint iReason, GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00099 <span class="keyword">virtual</span> GSvoid LobbyRcv_SubmitMatchResultReply(GSubyte ubType,
|
||||
00100 GSint iReason, GSint iMatchID) = 0;
|
||||
00101 <span class="keyword">virtual</span> GSvoid LobbyRcv_UpdatePing(GSint iGroupID, GSint iLobbySrvID,
|
||||
00102 GSchar *szUsername, GSushort usPing) = 0;
|
||||
00103
|
||||
00104 <span class="keyword">virtual</span> GSvoid LobbyRcv_StartGameReply(GSubyte ubType, GSint iReason,
|
||||
00105 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00106 <span class="keyword">virtual</span> GSvoid LobbyRcv_GameReadyReply(GSubyte ubType, GSint iReason,
|
||||
00107 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00108 <span class="keyword">virtual</span> GSvoid LobbyRcv_GameStarted(GSint iGroupID, GSint iLobbyServerID,
|
||||
00109 GSvoid *vpGameData, GSint iSize, GSchar *szIPAddress,
|
||||
00110 GSchar *szAltIPAddress, GSushort usPort) = 0;
|
||||
00111 <span class="keyword">virtual</span> GSvoid LobbyRcv_NewGameMember(GSint iGroupID, GSint iLobbyServerID,
|
||||
00112 GSchar *szUsername, GSbool bVisitor) = 0;
|
||||
00113
|
||||
00114 <span class="keyword">virtual</span> GSvoid LobbyRcv_UpdateGameInfoReply(GSubyte ubType, GSint iReason,
|
||||
00115 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00116 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerBanReply(GSubyte ubType, GSint iReason,
|
||||
00117 GSint iGroupID, GSint iLobbySrvID, GSchar *szUsername) = 0;
|
||||
00118 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerUnBanReply(GSubyte ubType, GSint iReason,
|
||||
00119 GSint iGroupID, GSint iLobbySrvID, GSchar *szUsername) = 0;
|
||||
00120 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerBanList(GSint iGroupID, GSint iLobbySrvID,
|
||||
00121 GSchar *szUsername) = 0;
|
||||
00122 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerBanned(GSint iGroupID, GSint iLobbySrvID,
|
||||
00123 GSchar *szReason) = 0;
|
||||
00124 <span class="keyword">virtual</span> GSvoid LobbyRcv_MatchReady(GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00125 <span class="keyword">virtual</span> GSvoid LobbyRcv_InfoRefresh(GSint iLobbySrvID) = 0;
|
||||
00126
|
||||
00127 <span class="keyword">virtual</span> GSvoid LobbyRcv_SetPlayerInfoReply(GSubyte ubType,
|
||||
00128 GSint iReason) = 0;
|
||||
00129 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerInfoUpdate(GSchar *szUsername,
|
||||
00130 GSvoid *vpPlayerData, GSint iPlayerDataSize) = 0;
|
||||
00131 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerGroupList(GSchar *szUsername,
|
||||
00132 GSint iGroupID, GSint iLobbySrvID) = 0;
|
||||
00133 <span class="keyword">virtual</span> GSvoid LobbyRcv_PlayerUpdateStatus( GSchar* szMember,
|
||||
00134 GSushort usPlayerStatus ) = 0;
|
||||
00135 <span class="keyword">virtual</span> GSvoid LobbyRcv_FinalMatchResults(GSuint uiMatchId, GSubyte ubType,
|
||||
00136 GSint iReason, <span class="keyword">const</span> <a class="code" href="structLADDER__ROW.html">LADDER_ROW</a> *pResults, GSuint uiNumResults) = 0;
|
||||
00137 };
|
||||
00138
|
||||
00139 <span class="preprocessor">#endif //__cplusplus</span>
|
||||
00140 <span class="preprocessor"></span>
|
||||
00145 <span class="comment">//============================================================================</span>
|
||||
00146 <span class="comment">// Callback CBLobbyRcv_LoginReply</span>
|
||||
00159 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00160"></a><a class="code" href="group__group__LobbyCB.html#a0">00160</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a0">CBLobbyRcv_LoginReply</a>)(GSubyte ubType,
|
||||
00161 GSint iReason);
|
||||
00162
|
||||
00163 <span class="comment">//============================================================================</span>
|
||||
00164 <span class="comment">// Callback CBLobbyRcv_LobbyDisconnection</span>
|
||||
00174 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00175"></a><a class="code" href="group__group__LobbyCB.html#a1">00175</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a1">CBLobbyRcv_LobbyDisconnection</a>)(GSint iLobbySrvID);
|
||||
00176
|
||||
00177 <span class="comment">//============================================================================</span>
|
||||
00178 <span class="comment">// Callback CBLobbyRcv_LobbyDisconnectAll</span>
|
||||
00188 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00189"></a><a class="code" href="group__group__LobbyCB.html#a2">00189</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a2">CBLobbyRcv_LobbyDisconnectAll</a>)();
|
||||
00190
|
||||
00191 <span class="comment">//============================================================================</span>
|
||||
00192 <span class="comment">// Callback CBLobbyRcv_CreateRoomReply</span>
|
||||
00223 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00224"></a><a class="code" href="group__group__LobbyCB.html#a3">00224</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a3">CBLobbyRcv_CreateRoomReply</a>)(GSubyte ubType,
|
||||
00225 GSint iReason, GSchar* szRoom, GSint iGroupID, GSint iLobbySrvID);
|
||||
00226
|
||||
00227 <span class="comment">//============================================================================</span>
|
||||
00228 <span class="comment">// Callback CBLobbyRcv_NewRoom</span>
|
||||
00262 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00263"></a><a class="code" href="group__group__LobbyCB.html#a4">00263</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a4">CBLobbyRcv_NewRoom</a>)(GSshort sGroupType,
|
||||
00264 GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID,
|
||||
00265 GSint iConfig, GSshort sGroupLevel, GSchar *szMaster,
|
||||
00266 GSchar *szAllowedGames, GSchar *szGames, GSchar *szGameVersion,
|
||||
00267 GSchar *szGSVersion, GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer,
|
||||
00268 GSuint uiNbrPlayer, GSuint uiMaxVisitor, GSuint uiNbrVisitor,
|
||||
00269 GSchar *szIPAddress, GSchar *szAltIPAddress, GSint iEventID);
|
||||
00270
|
||||
00271 <span class="comment">//============================================================================</span>
|
||||
00272 <span class="comment">// Callback CBLobbyRcv_NewLobby</span>
|
||||
00297 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00298"></a><a class="code" href="group__group__LobbyCB.html#a5">00298</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a5">CBLobbyRcv_NewLobby</a>)(GSshort sGroupType,
|
||||
00299 GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID,
|
||||
00300 GSint iConfig, GSshort siGroupLevel, GSchar *szMaster,
|
||||
00301 GSchar *szAllowedGames, GSchar *szGames, GSvoid *vpInfo, GSint iSize,
|
||||
00302 GSuint uiMaxMember, GSuint uiNbrMember, GSint iEventID);
|
||||
00303
|
||||
00304
|
||||
00305
|
||||
00306 <span class="comment">//============================================================================</span>
|
||||
00307 <span class="comment">// Callback CBLobbyRcv_RoomInfo</span>
|
||||
00341 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00342"></a><a class="code" href="group__group__LobbyCB.html#a6">00342</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a6">CBLobbyRcv_RoomInfo</a>)(GSshort sGroupType,
|
||||
00343 GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID,
|
||||
00344 GSint iConfig, GSshort sGroupLevel, GSchar *szMaster,
|
||||
00345 GSchar *szAllowedGames,GSchar *szGames, GSchar *szGameVersion,
|
||||
00346 GSchar *szGSVersion, GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer,
|
||||
00347 GSuint uiNbrPlayer, GSuint uiMaxVisitor, GSuint uiNbrVisitor,
|
||||
00348 GSchar *szIPAddress, GSchar *szAltIPAddress, GSint iEventID);
|
||||
00349
|
||||
00350
|
||||
00351
|
||||
00352 <span class="comment">//============================================================================</span>
|
||||
00353 <span class="comment">// Callback CBLobbyRcv_LobbyInfo</span>
|
||||
00379 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00380"></a><a class="code" href="group__group__LobbyCB.html#a7">00380</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a7">CBLobbyRcv_LobbyInfo</a>)(GSshort siGroupType,
|
||||
00381 GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID,
|
||||
00382 GSint iConfig, GSshort siGroupLevel, GSchar *szMaster,
|
||||
00383 GSchar *szAllowedGames, GSchar *szGames, GSvoid *vpInfo, GSint iSize,
|
||||
00384 GSuint uiMaxMember, GSuint uiNbrMember, GSint iEventID);
|
||||
00385
|
||||
00386
|
||||
00387 <span class="comment">//============================================================================</span>
|
||||
00388 <span class="comment">// Callback CBLobbyRcv_GroupInfoGet</span>
|
||||
00402 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00403"></a><a class="code" href="group__group__LobbyCB.html#a8">00403</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a8">CBLobbyRcv_GroupInfoGet</a>)(GSubyte ubType,
|
||||
00404 GSint iLobbyID,GSint iRoomID);
|
||||
00405
|
||||
00406 <span class="comment">//============================================================================</span>
|
||||
00407 <span class="comment">// Callback CBLobbyRcv_GroupRemove</span>
|
||||
00421 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00422"></a><a class="code" href="group__group__LobbyCB.html#a9">00422</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a9">CBLobbyRcv_GroupRemove</a>)(GSint iGroupID,
|
||||
00423 GSint iLobbySrvID);
|
||||
00424
|
||||
00425 <span class="comment">//============================================================================</span>
|
||||
00426 <span class="comment">// Callback CBLobbyRcv_JoinRoomReply</span>
|
||||
00427
|
||||
00456 <span class="comment">//============================================================================</span>
|
||||
<a name="l00457"></a><a class="code" href="group__group__LobbyCB.html#a10">00457</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a10">CBLobbyRcv_JoinRoomReply</a>)(GSubyte ubType,
|
||||
00458 GSint iReason, GSchar *szReason, GSint iGroupID, GSint iLobbySrvID);
|
||||
00459
|
||||
00460 <span class="comment">//============================================================================</span>
|
||||
00461 <span class="comment">// Callback CBLobbyRcv_JoinLobbyResult</span>
|
||||
00462
|
||||
00485 <span class="comment">//============================================================================</span>
|
||||
<a name="l00486"></a><a class="code" href="group__group__LobbyCB.html#a11">00486</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a11">CBLobbyRcv_JoinLobbyReply</a>)(GSubyte ubType,
|
||||
00487 GSint iReason, GSchar *szReason, GSint iGroupID, GSint iLobbySrvID);
|
||||
00488
|
||||
00489 <span class="comment">//============================================================================</span>
|
||||
00490 <span class="comment">// Callback CBLobbyRcv_MemberJoined</span>
|
||||
00491
|
||||
00517 <span class="comment">//============================================================================</span>
|
||||
<a name="l00518"></a><a class="code" href="group__group__LobbyCB.html#a12">00518</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a12">CBLobbyRcv_MemberJoined</a>)(GSchar* szUsername,
|
||||
00519 GSbool bVisitor, GSint* piGroupID, GSushort usNbGroups, GSint iLobbySrvID,
|
||||
00520 GSchar *szIPAddress, GSchar *szAltIPAddress, GSushort usPing,
|
||||
00521 GSvoid *vpPlayerData, GSint iPlayerDataSize, GSbool bJoin,
|
||||
00522 GSushort usPlayerStatus );
|
||||
00523
|
||||
00524 <span class="comment">//============================================================================</span>
|
||||
00525 <span class="comment">// Callback CBLobbyRcv_MemberLeave</span>
|
||||
00526
|
||||
00538 <span class="comment">//============================================================================</span>
|
||||
<a name="l00539"></a><a class="code" href="group__group__LobbyCB.html#a13">00539</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a13">CBLobbyRcv_MemberLeave</a>)(GSchar *szUsername,
|
||||
00540 GSint iGroupID, GSint iLobbySrvID);
|
||||
00541
|
||||
00542
|
||||
00543 <span class="comment">//============================================================================</span>
|
||||
00544 <span class="comment">// Callback CBLobbyRcv_StartMatchReply</span>
|
||||
00545
|
||||
00568 <span class="comment">//============================================================================</span>
|
||||
<a name="l00569"></a><a class="code" href="group__group__LobbyCB.html#a14">00569</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a14">CBLobbyRcv_StartMatchReply</a>)(GSubyte ubType,
|
||||
00570 GSint iReason, GSint iGroupID, GSint iLobbySrvID);
|
||||
00571
|
||||
00572 <span class="comment">//============================================================================</span>
|
||||
00573 <span class="comment">// Callback CBLobbyRcv_MasterChanged</span>
|
||||
00574
|
||||
00595 <span class="comment">//============================================================================</span>
|
||||
<a name="l00596"></a><a class="code" href="group__group__LobbyCB.html#a15">00596</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a15">CBLobbyRcv_MasterChanged</a>)(GSint iGroupID,
|
||||
00597 GSint iLobbySrvID, GSchar *szUsername, GSchar *szIPAddress,
|
||||
00598 GSchar *szAltIPAddress);
|
||||
00599
|
||||
00600 <span class="comment">//============================================================================</span>
|
||||
00601 <span class="comment">// Callback CBLobbyRcv_MasterNewReply</span>
|
||||
00602
|
||||
00624 <span class="comment">//============================================================================</span>
|
||||
<a name="l00625"></a><a class="code" href="group__group__LobbyCB.html#a16">00625</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a16">CBLobbyRcv_MasterNewReply</a>)(GSubyte ubType,
|
||||
00626 GSint iReason, GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID);
|
||||
00627
|
||||
00628 <span class="comment">//============================================================================</span>
|
||||
00629 <span class="comment">// Callback CBLobbyRcv_MatchFinishReply</span>
|
||||
00630
|
||||
00649 <span class="comment">//============================================================================</span>
|
||||
<a name="l00650"></a><a class="code" href="group__group__LobbyCB.html#a17">00650</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a17">CBLobbyRcv_MatchFinishReply</a>)(GSubyte ubType,
|
||||
00651 GSint iReason, GSint iGroupID, GSint iLobbySrvID);
|
||||
00652
|
||||
00653 <span class="comment">//============================================================================</span>
|
||||
00654 <span class="comment">// Callback CBLobbyRcv_PlayerKickReply</span>
|
||||
00655
|
||||
00676 <span class="comment">//============================================================================</span>
|
||||
<a name="l00677"></a><a class="code" href="group__group__LobbyCB.html#a18">00677</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a18">CBLobbyRcv_PlayerKickReply</a>)(GSubyte ubType,
|
||||
00678 GSint iReason, GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID);
|
||||
00679
|
||||
00680 <span class="comment">//============================================================================</span>
|
||||
00681 <span class="comment">// Callback CBLobbyRcv_KickOut</span>
|
||||
00682
|
||||
00696 <span class="comment">//============================================================================</span>
|
||||
<a name="l00697"></a><a class="code" href="group__group__LobbyCB.html#a19">00697</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a19">CBLobbyRcv_KickOut</a>)(GSint iGroupID,
|
||||
00698 GSint iLobbySrvID, GSchar *szReason);
|
||||
00699
|
||||
00700 <span class="comment">//============================================================================</span>
|
||||
00701 <span class="comment">// Callback CBLobbyRcv_ParentGroupIDReply</span>
|
||||
00702
|
||||
00722 <span class="comment">//============================================================================</span>
|
||||
<a name="l00723"></a><a class="code" href="group__group__LobbyCB.html#a20">00723</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a20">CBLobbyRcv_ParentGroupIDReply</a>)(GSubyte ubType,
|
||||
00724 GSint iReason, GSint iGroupID, GSint iLobbySrvID, GSint iParentGroupID);
|
||||
00725
|
||||
00726 <span class="comment">//============================================================================</span>
|
||||
00727 <span class="comment">// Callback CBLobbyRcv_GetAlternateGroupInfoReply</span>
|
||||
00728
|
||||
00747 <span class="comment">//============================================================================</span>
|
||||
<a name="l00748"></a><a class="code" href="group__group__LobbyCB.html#a21">00748</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a21">CBLobbyRcv_GetAlternateGroupInfoReply</a>)(
|
||||
00749 GSubyte ubType, GSint iReason, <span class="keyword">const</span> GSvoid* pcAltGroupInfo,
|
||||
00750 GSint iAltGroupInfoSize, GSint iGroupID, GSint iLobbyServerID );
|
||||
00751
|
||||
00752 <span class="comment">//============================================================================</span>
|
||||
00753 <span class="comment">// Callback CBLobbyRcv_GroupLeaveReply</span>
|
||||
00754
|
||||
00773 <span class="comment">//============================================================================</span>
|
||||
<a name="l00774"></a><a class="code" href="group__group__LobbyCB.html#a22">00774</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a22">CBLobbyRcv_GroupLeaveReply</a>)(GSubyte ubType,
|
||||
00775 GSint iReason, GSint iGroupID, GSint iLobbySrvID);
|
||||
00776
|
||||
00777
|
||||
00778 <span class="comment">//============================================================================</span>
|
||||
00779 <span class="comment">// Callback CBLobbyRcv_GroupConfigUpdate</span>
|
||||
00780
|
||||
00793 <span class="comment">//============================================================================</span>
|
||||
<a name="l00794"></a><a class="code" href="group__group__LobbyCB.html#a23">00794</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a23">CBLobbyRcv_GroupConfigUpdate</a>)(GSint iGroupID,
|
||||
00795 GSint iLobbySrvID, GSint iFlags);
|
||||
00796
|
||||
00797
|
||||
00798 <span class="comment">//============================================================================</span>
|
||||
00799 <span class="comment">// Callback CBLobbyRcv_MatchStarted</span>
|
||||
00800
|
||||
00815 <span class="comment">//============================================================================</span>
|
||||
<a name="l00816"></a><a class="code" href="group__group__LobbyCB.html#a24">00816</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a24">CBLobbyRcv_MatchStarted</a>)(GSint iGroupID,
|
||||
00817 GSint iLobbyServerID, GSuint uiMatchID);
|
||||
00818
|
||||
00819 <span class="comment">//============================================================================</span>
|
||||
00820 <span class="comment">// Callback CBLobbyRcv_UpdateRoomConfigReply</span>
|
||||
00821
|
||||
00840 <span class="comment">//============================================================================</span>
|
||||
<a name="l00841"></a><a class="code" href="group__group__LobbyCB.html#a25">00841</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a25">CBLobbyRcv_UpdateRoomConfigReply</a>)(GSubyte ubType,
|
||||
00842 GSint iReason, GSint iGroupID, GSint iLobbyServerID);
|
||||
00843
|
||||
00844 <span class="comment">//============================================================================</span>
|
||||
00845 <span class="comment">// Callback CBLobbyRcv_SubmitMatchResultReply</span>
|
||||
00846
|
||||
00865 <span class="comment">//============================================================================</span>
|
||||
<a name="l00866"></a><a class="code" href="group__group__LobbyCB.html#a26">00866</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a26">CBLobbyRcv_SubmitMatchResultReply</a>)(GSubyte ubType,
|
||||
00867 GSint iReason, GSint iMatchID);
|
||||
00868
|
||||
00869 <span class="comment">//============================================================================</span>
|
||||
00870 <span class="comment">// Callback CBLobbyRcv_UpdatePing</span>
|
||||
00871
|
||||
00885 <span class="comment">//============================================================================</span>
|
||||
<a name="l00886"></a><a class="code" href="group__group__LobbyCB.html#a27">00886</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a27">CBLobbyRcv_UpdatePing</a>)(GSint iGroupID,
|
||||
00887 GSint iLobbyServerID, GSchar *szUsername, GSushort usPing);
|
||||
00888
|
||||
00889
|
||||
00890
|
||||
00891 <span class="comment">//============================================================================</span>
|
||||
00892 <span class="comment">// Callback CBLobbyRcv_StartGame</span>
|
||||
00893
|
||||
00916 <span class="comment">//============================================================================</span>
|
||||
<a name="l00917"></a><a class="code" href="group__group__LobbyCB.html#a28">00917</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a28">CBLobbyRcv_StartGameReply</a>)(GSubyte ubType,
|
||||
00918 GSint iReason, GSint iGroupID, GSint iLobbyServerID);
|
||||
00919
|
||||
00920 <span class="comment">//============================================================================</span>
|
||||
00921 <span class="comment">// Callback CBLobbyRcv_GameReadyReply</span>
|
||||
00922
|
||||
00942 <span class="comment">//============================================================================</span>
|
||||
<a name="l00943"></a><a class="code" href="group__group__LobbyCB.html#a29">00943</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a29">CBLobbyRcv_GameReadyReply</a>)(GSubyte ubType,
|
||||
00944 GSint iReason, GSint iGroupID, GSint iLobbyServerID);
|
||||
00945
|
||||
00946 <span class="comment">//============================================================================</span>
|
||||
00947 <span class="comment">// Callback CBLobbyRcv_GameStarted</span>
|
||||
00948
|
||||
00968 <span class="comment">//============================================================================</span>
|
||||
<a name="l00969"></a><a class="code" href="group__group__LobbyCB.html#a30">00969</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a30">CBLobbyRcv_GameStarted</a>)(GSint iGroupID,
|
||||
00970 GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSchar *szIPAddress,
|
||||
00971 GSchar *szAltIPAddress, GSushort usPort);
|
||||
00972
|
||||
00973 <span class="comment">//============================================================================</span>
|
||||
00974 <span class="comment">// Callback CBLobbyRcv_NewGameMember</span>
|
||||
00975
|
||||
00990 <span class="comment">//============================================================================</span>
|
||||
<a name="l00991"></a><a class="code" href="group__group__LobbyCB.html#a31">00991</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a31">CBLobbyRcv_NewGameMember</a>)(GSint iGroupID,
|
||||
00992 GSint iLobbyServerID, GSchar *szUsername, GSbool bVisitor);
|
||||
00993
|
||||
00994 <span class="comment">//============================================================================</span>
|
||||
00995 <span class="comment">// Callback CBLobbyRcv_UpdateGameInfoReply</span>
|
||||
00996
|
||||
01016 <span class="comment">//============================================================================</span>
|
||||
<a name="l01017"></a><a class="code" href="group__group__LobbyCB.html#a32">01017</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a32">CBLobbyRcv_UpdateGameInfoReply</a>)(GSubyte ubType,
|
||||
01018 GSint iReason, GSint iGroupID, GSint iLobbyServerID);
|
||||
01019
|
||||
01020 <span class="comment">//============================================================================</span>
|
||||
01021 <span class="comment">// Callback CBLobbyRcv_PlayerBanReply</span>
|
||||
01022
|
||||
01043 <span class="comment">//============================================================================</span>
|
||||
<a name="l01044"></a><a class="code" href="group__group__LobbyCB.html#a33">01044</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a33">CBLobbyRcv_PlayerBanReply</a>)(GSubyte ubType,
|
||||
01045 GSint iReason, GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername);
|
||||
01046
|
||||
01047 <span class="comment">//============================================================================</span>
|
||||
01048 <span class="comment">// Callback CBLobbyRcv_PlayerUnBanReply</span>
|
||||
01049
|
||||
01069 <span class="comment">//============================================================================</span>
|
||||
<a name="l01070"></a><a class="code" href="group__group__LobbyCB.html#a34">01070</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a34">CBLobbyRcv_PlayerUnBanReply</a>)(GSubyte ubType,
|
||||
01071 GSint iReason, GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername);
|
||||
01072
|
||||
01073 <span class="comment">//============================================================================</span>
|
||||
01074 <span class="comment">// Callback CBLobbyRcv_PlayerBanList</span>
|
||||
01075
|
||||
01093 <span class="comment">//============================================================================</span>
|
||||
<a name="l01094"></a><a class="code" href="group__group__LobbyCB.html#a35">01094</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a35">CBLobbyRcv_PlayerBanList</a>)(GSint iGroupID,
|
||||
01095 GSint iLobbyServerID, GSchar *szUsername);
|
||||
01096
|
||||
01097 <span class="comment">//============================================================================</span>
|
||||
01098 <span class="comment">// Callback CBLobbyRcv_PlayerBanned</span>
|
||||
01099
|
||||
01112 <span class="comment">//============================================================================</span>
|
||||
<a name="l01113"></a><a class="code" href="group__group__LobbyCB.html#a36">01113</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a36">CBLobbyRcv_PlayerBanned</a>)(GSint iGroupID,
|
||||
01114 GSint iLobbySrvID, GSchar *szReason);
|
||||
01115
|
||||
01116 <span class="comment">//============================================================================</span>
|
||||
01117 <span class="comment">// Callback CBLobbyRcv_MatchReady</span>
|
||||
01127 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l01128"></a><a class="code" href="group__group__LobbyCB.html#a37">01128</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a37">CBLobbyRcv_MatchReady</a>)(GSint iGroupID,
|
||||
01129 GSint iLobbySrvID);
|
||||
01130
|
||||
01131 <span class="comment">//============================================================================</span>
|
||||
01132 <span class="comment">// Callback CBLobbyRcv_InfoRefresh</span>
|
||||
01141 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l01142"></a><a class="code" href="group__group__LobbyCB.html#a38">01142</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a38">CBLobbyRcv_InfoRefresh</a>)(GSint iLobbySrvID);
|
||||
01143
|
||||
01144 <span class="comment">//============================================================================</span>
|
||||
01145 <span class="comment">// Callback CBLobbyRcv_SetPlayerInfoReply</span>
|
||||
01154 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l01155"></a><a class="code" href="group__group__LobbyCB.html#a39">01155</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a39">CBLobbyRcv_SetPlayerInfoReply</a>)(GSubyte ubType,
|
||||
01156 GSint iReason);
|
||||
01157
|
||||
01158 <span class="comment">//============================================================================</span>
|
||||
01159 <span class="comment">// Callback CBLobbyRcv_PlayerInfoUpdate</span>
|
||||
01160
|
||||
01170 <span class="comment">//============================================================================</span>
|
||||
<a name="l01171"></a><a class="code" href="group__group__LobbyCB.html#a40">01171</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a40">CBLobbyRcv_PlayerInfoUpdate</a>)(GSchar *szUsername,
|
||||
01172 GSvoid *vpPlayerData, GSint iPlayerDataSize);
|
||||
01173
|
||||
01174 <span class="comment">//============================================================================</span>
|
||||
01175 <span class="comment">// Callback CBLobbyRcv_PlayerInfoUpdate</span>
|
||||
01176
|
||||
01186 <span class="comment">//============================================================================</span>
|
||||
<a name="l01187"></a><a class="code" href="group__group__LobbyCB.html#a41">01187</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a>)( GSchar* szUsername,
|
||||
01188 GSushort usPlayerStatus );
|
||||
01189
|
||||
01190 <span class="comment">//============================================================================</span>
|
||||
01191 <span class="comment">// Callback CBLobbyRcv_PlayerGroupList</span>
|
||||
01192
|
||||
01202 <span class="comment">//============================================================================</span>
|
||||
<a name="l01203"></a><a class="code" href="group__group__LobbyCB.html#a42">01203</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a42">CBLobbyRcv_PlayerGroupList</a>)(GSchar *szUsername,
|
||||
01204 GSint iGroupID, GSint iLobbySrvID);
|
||||
01205
|
||||
01206 <span class="comment">//===============================================================================</span>
|
||||
01207 <span class="comment">// Callback CBLobbyRcv_FinalMatchResults</span>
|
||||
01208
|
||||
01241 <span class="comment">//===============================================================================</span>
|
||||
<a name="l01242"></a><a class="code" href="group__group__LobbyCB.html#a43">01242</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LobbyCB.html#a43">CBLobbyRcv_FinalMatchResults</a>)(GSuint uiMatchId,
|
||||
01243 GSubyte ubType, GSint iReason, <span class="keyword">const</span> <a class="code" href="structLADDER__ROW.html">LADDER_ROW</a> *pResults,
|
||||
01244 GSuint uiNumResult);
|
||||
01245
|
||||
01248 <span class="preprocessor">#endif //_GSLOBBYCB_H_</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,161 @@
|
||||
<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>GSLobbyCB.h File Reference</h1>Callback functions for the <b><em>lobby service</em></b>.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
<code>#include "<a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a>"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSLobbyCB_8h-source.html">Go to the source code of this file.</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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a0">CBLobbyRcv_LoginReply</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the login request. </em> <a href="group__group__LobbyCB.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a1">CBLobbyRcv_LobbyDisconnection</a> )(GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Client as been disconnected from lobby server. </em> <a href="group__group__LobbyCB.html#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a2">CBLobbyRcv_LobbyDisconnectAll</a> )()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Client as been disconnected from lobby server. </em> <a href="group__group__LobbyCB.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a3">CBLobbyRcv_CreateRoomReply</a> )(GSubyte ubType, GSint iReason, GSchar *szRoom, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the create room request. </em> <a href="group__group__LobbyCB.html#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a4">CBLobbyRcv_NewRoom</a> )(GSshort sGroupType, GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig, GSshort sGroupLevel, GSchar *szMaster, GSchar *szAllowedGames, GSchar *szGames, GSchar *szGameVersion, GSchar *szGSVersion, GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer, GSuint uiNbrPlayer, GSuint uiMaxVisitor, GSuint uiNbrVisitor, GSchar *szIPAddress, GSchar *szAltIPAddress, GSint iEventID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message informing of a newly created room. </em> <a href="group__group__LobbyCB.html#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a5">CBLobbyRcv_NewLobby</a> )(GSshort sGroupType, GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig, GSshort siGroupLevel, GSchar *szMaster, GSchar *szAllowedGames, GSchar *szGames, GSvoid *vpInfo, GSint iSize, GSuint uiMaxMember, GSuint uiNbrMember, GSint iEventID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message informing of a newly created lobby. </em> <a href="group__group__LobbyCB.html#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a6">CBLobbyRcv_RoomInfo</a> )(GSshort sGroupType, GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig, GSshort sGroupLevel, GSchar *szMaster, GSchar *szAllowedGames, GSchar *szGames, GSchar *szGameVersion, GSchar *szGSVersion, GSvoid *vpInfo, GSint iSize, GSuint uiMaxPlayer, GSuint uiNbrPlayer, GSuint uiMaxVisitor, GSuint uiNbrVisitor, GSchar *szIPAddress, GSchar *szAltIPAddress, GSint iEventID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message about updated room infomations. </em> <a href="group__group__LobbyCB.html#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a7">CBLobbyRcv_LobbyInfo</a> )(GSshort siGroupType, GSchar *szGroupName, GSint iGroupID, GSint iLobbySrvID, GSint iParentID, GSint iConfig, GSshort siGroupLevel, GSchar *szMaster, GSchar *szAllowedGames, GSchar *szGames, GSvoid *vpInfo, GSint iSize, GSuint uiMaxMember, GSuint uiNbrMember, GSint iEventID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message about updated room infomations. </em> <a href="group__group__LobbyCB.html#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a8">CBLobbyRcv_GroupInfoGet</a> )(GSubyte ubType, GSint iLobbyID, GSint iRoomID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Received when a call to LobbySend_GroupInfoGet fails. </em> <a href="group__group__LobbyCB.html#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a9">CBLobbyRcv_GroupRemove</a> )(GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a indication that a group as been removed. </em> <a href="group__group__LobbyCB.html#a9"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a10">CBLobbyRcv_JoinRoomReply</a> )(GSubyte ubType, GSint iReason, GSchar *szReason, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the join room request. </em> <a href="group__group__LobbyCB.html#a10"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a11">CBLobbyRcv_JoinLobbyReply</a> )(GSubyte ubType, GSint iReason, GSchar *szReason, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the join lobby request. </em> <a href="group__group__LobbyCB.html#a11"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a12">CBLobbyRcv_MemberJoined</a> )(GSchar *szUsername, GSbool bVisitor, GSint *piGroupID, GSushort usNbGroups, GSint iLobbySrvID, GSchar *szIPAddress, GSchar *szAltIPAddress, GSushort usPing, GSvoid *vpPlayerData, GSint iPlayerDataSize, GSbool bJoin, GSushort usPlayerStatus)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message informaing of a new member. </em> <a href="group__group__LobbyCB.html#a12"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a13">CBLobbyRcv_MemberLeave</a> )(GSchar *szUsername, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message informaing member leaving a group. </em> <a href="group__group__LobbyCB.html#a13"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a14">CBLobbyRcv_StartMatchReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the start match request. </em> <a href="group__group__LobbyCB.html#a14"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a15">CBLobbyRcv_MasterChanged</a> )(GSint iGroupID, GSint iLobbySrvID, GSchar *szUsername, GSchar *szIPAddress, GSchar *szAltIPAddress)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a member join message. </em> <a href="group__group__LobbyCB.html#a15"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a16">CBLobbyRcv_MasterNewReply</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a member join message. </em> <a href="group__group__LobbyCB.html#a16"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a17">CBLobbyRcv_MatchFinishReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a member join message. </em> <a href="group__group__LobbyCB.html#a17"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a18">CBLobbyRcv_PlayerKickReply</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a PlayerKick message. </em> <a href="group__group__LobbyCB.html#a18"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a19">CBLobbyRcv_KickOut</a> )(GSint iGroupID, GSint iLobbySrvID, GSchar *szReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a KickOut message. </em> <a href="group__group__LobbyCB.html#a19"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a20">CBLobbyRcv_ParentGroupIDReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbySrvID, GSint iParentGroupID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a ParentGroupID message. </em> <a href="group__group__LobbyCB.html#a20"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a21">CBLobbyRcv_GetAlternateGroupInfoReply</a> )(GSubyte ubType, GSint iReason, const GSvoid *pcAltGroupInfo, GSint iAltGroupInfoSize, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a ParentGroupID message. </em> <a href="group__group__LobbyCB.html#a21"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a22">CBLobbyRcv_GroupLeaveReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a GroupLeave message. </em> <a href="group__group__LobbyCB.html#a22"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a23">CBLobbyRcv_GroupConfigUpdate</a> )(GSint iGroupID, GSint iLobbySrvID, GSint iFlags)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a GroupConfigUpdate message. </em> <a href="group__group__LobbyCB.html#a23"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a24">CBLobbyRcv_MatchStarted</a> )(GSint iGroupID, GSint iLobbyServerID, GSuint uiMatchID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a MatchStarted message. </em> <a href="group__group__LobbyCB.html#a24"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a25">CBLobbyRcv_UpdateRoomConfigReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a GroupConfigUpdateResult message. </em> <a href="group__group__LobbyCB.html#a25"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a26">CBLobbyRcv_SubmitMatchResultReply</a> )(GSubyte ubType, GSint iReason, GSint iMatchID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a SubmitMatchResult message. </em> <a href="group__group__LobbyCB.html#a26"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a27">CBLobbyRcv_UpdatePing</a> )(GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername, GSushort usPing)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a UpdatePing message. </em> <a href="group__group__LobbyCB.html#a27"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a28">CBLobbyRcv_StartGameReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a StartGame message. </em> <a href="group__group__LobbyCB.html#a28"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a29">CBLobbyRcv_GameReadyReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a GameReady message. </em> <a href="group__group__LobbyCB.html#a29"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a30">CBLobbyRcv_GameStarted</a> )(GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSchar *szIPAddress, GSchar *szAltIPAddress, GSushort usPort)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a GameStarted message. </em> <a href="group__group__LobbyCB.html#a30"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a31">CBLobbyRcv_NewGameMember</a> )(GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername, GSbool bVisitor)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a NewGameMember message. </em> <a href="group__group__LobbyCB.html#a31"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a32">CBLobbyRcv_UpdateGameInfoReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a UpdateGameInfoReply message. </em> <a href="group__group__LobbyCB.html#a32"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a33">CBLobbyRcv_PlayerBanReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a PlayerBanReply message. </em> <a href="group__group__LobbyCB.html#a33"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a34">CBLobbyRcv_PlayerUnBanReply</a> )(GSubyte ubType, GSint iReason, GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a PlayerUnBanReply message. </em> <a href="group__group__LobbyCB.html#a34"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a35">CBLobbyRcv_PlayerBanList</a> )(GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a PlayerUnBanReply message. </em> <a href="group__group__LobbyCB.html#a35"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a36">CBLobbyRcv_PlayerBanned</a> )(GSint iGroupID, GSint iLobbySrvID, GSchar *szReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a PlayerBan message. </em> <a href="group__group__LobbyCB.html#a36"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a37">CBLobbyRcv_MatchReady</a> )(GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a MatchReady message. </em> <a href="group__group__LobbyCB.html#a37"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a38">CBLobbyRcv_InfoRefresh</a> )(GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a InfoRefresh message telling that it would be good to refresh all group and player related information. </em> <a href="group__group__LobbyCB.html#a38"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a39">CBLobbyRcv_SetPlayerInfoReply</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a reply after having sent a request to change player information. </em> <a href="group__group__LobbyCB.html#a39"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a40">CBLobbyRcv_PlayerInfoUpdate</a> )(GSchar *szUsername, GSvoid *vpPlayerData, GSint iPlayerDataSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a reply after having sent a request to change player information. </em> <a href="group__group__LobbyCB.html#a40"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> )(GSchar *szUsername, GSushort usPlayerStatus)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive an update of the player's status. </em> <a href="group__group__LobbyCB.html#a41"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a42">CBLobbyRcv_PlayerGroupList</a> )(GSchar *szUsername, GSint iGroupID, GSint iLobbySrvID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message telling that a player is member of a specific group. </em> <a href="group__group__LobbyCB.html#a42"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LobbyCB.html#a43">CBLobbyRcv_FinalMatchResults</a> )(GSuint uiMatchId, GSubyte ubType, GSint iReason, const <a class="el" href="structLADDER__ROW.html">LADDER_ROW</a> *pResults, GSuint uiNumResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Official results of a match. </em> <a href="group__group__LobbyCB.html#a43"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file contains all callback functions declaration for the lobby service.<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>
|
||||
@@ -0,0 +1,122 @@
|
||||
<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>GSLoginCB.h</h1><a href="GSLoginCB_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">//****************************************************************************</span>
|
||||
00002 <span class="comment">//* Author: Guillaume Plante <gsdevteam@ubisoft.com></span>
|
||||
00003 <span class="comment">//* Date: 5/16/01 9:20:13 AM</span>
|
||||
00010 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00011
|
||||
00012
|
||||
00013 <span class="preprocessor">#ifndef __GSLOGINCB_H_</span>
|
||||
00014 <span class="preprocessor"></span><span class="preprocessor">#define __GSLOGINCB_H_</span>
|
||||
00015 <span class="preprocessor"></span>
|
||||
00016 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00017
|
||||
00018 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
00019 <span class="preprocessor"></span><span class="keyword">class </span>clLoginCallbacks
|
||||
00020 {
|
||||
00021 <span class="keyword">public</span>:
|
||||
00022 <span class="keyword">virtual</span> GSvoid LoginRcv_PlayerInfo(GSubyte ubType, GSchar * pszNickName,
|
||||
00023 GSchar * pszSurName, GSchar * pszFirstName, GSchar * pszCountry,
|
||||
00024 GSchar * pszEmail, GSchar * szIRCID, GSchar * szIPAddress,
|
||||
00025 GSint iReason ) = 0;
|
||||
00026 <span class="keyword">virtual</span> GSvoid LoginRcv_JoinWaitModuleResult(GSubyte ubType,
|
||||
00027 GSchar * pszAddress, GSushort lPort, GSint iReason) = 0;
|
||||
00028 <span class="keyword">virtual</span> GSvoid LoginRcv_LoginRouterResult(GSubyte ubType, GSint iReason) = 0;
|
||||
00029 <span class="keyword">virtual</span> GSvoid LoginRcv_LoginWaitModuleResult(GSubyte ubType,
|
||||
00030 GSint iReason) = 0;
|
||||
00031 <span class="keyword">virtual</span> GSvoid LoginRcv_SystemPage(GSint lSubType, GSchar * pszText) = 0;
|
||||
00032 <span class="keyword">virtual</span> GSvoid LoginRcv_LoginDisconnection() = 0;
|
||||
00033 <span class="keyword">virtual</span> GSvoid LoginRcv_AccountCreationResult(GSubyte ubType,
|
||||
00034 GSint iReason) = 0;
|
||||
00035 <span class="keyword">virtual</span> GSvoid LoginRcv_ModifyUserResult(GSubyte ubType, GSint iReason) = 0;
|
||||
00036 <span class="keyword">virtual</span> GSvoid LoginRcv_RequestMOTD(GSubyte ubType, GSchar *szUbiMOTD,
|
||||
00037 GSchar *szGameMOTD, GSint iReason)=0;
|
||||
00038 };
|
||||
00039 <span class="preprocessor">#endif //__cplusplus</span>
|
||||
00040 <span class="preprocessor"></span>
|
||||
00041
|
||||
00046 <span class="comment">//============================================================================</span>
|
||||
00047 <span class="comment">// Callback CBLoginRcv_PlayerInfo</span>
|
||||
00071 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00072"></a><a class="code" href="group__group__LoginCB.html#a0">00072</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a0">CBLoginRcv_PlayerInfo</a>)(GSubyte ubType,
|
||||
00073 GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName,
|
||||
00074 GSchar *szCountry, GSchar *szEmail,GSchar *szIRCID, GSchar *szIPAddress,
|
||||
00075 GSint iReason);
|
||||
00076
|
||||
00077
|
||||
00078 <span class="comment">//============================================================================</span>
|
||||
00079 <span class="comment">// Callback CBLoginRcv_JoinWaitModuleResult</span>
|
||||
00096 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00097"></a><a class="code" href="group__group__LoginCB.html#a1">00097</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a1">CBLoginRcv_JoinWaitModuleResult</a>)(GSubyte ubType,
|
||||
00098 GSchar *szAddress, GSushort usPort, GSint iReason);
|
||||
00099
|
||||
00100
|
||||
00101 <span class="comment">//============================================================================</span>
|
||||
00102 <span class="comment">// Callback CBLoginRcv_LoginRouterResult</span>
|
||||
00103
|
||||
00127 <span class="comment">//============================================================================</span>
|
||||
<a name="l00128"></a><a class="code" href="group__group__LoginCB.html#a2">00128</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a>)(GSubyte ubType,
|
||||
00129 GSint iReason);
|
||||
00130
|
||||
00131
|
||||
00132 <span class="comment">//============================================================================</span>
|
||||
00133 <span class="comment">// Callback CBLoginRcv_LoginWaitModuleResult</span>
|
||||
00134
|
||||
00151 <span class="comment">//============================================================================</span>
|
||||
<a name="l00152"></a><a class="code" href="group__group__LoginCB.html#a3">00152</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a3">CBLoginRcv_LoginWaitModuleResult</a>)(GSubyte ubType,
|
||||
00153 GSint iReason);
|
||||
00154
|
||||
00155 <span class="comment">//============================================================================</span>
|
||||
00156 <span class="comment">// Callback CBLoginRcv_SystemPage</span>
|
||||
00157
|
||||
00180 <span class="comment">//============================================================================</span>
|
||||
<a name="l00181"></a><a class="code" href="group__group__LoginCB.html#a4">00181</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a4">CBLoginRcv_SystemPage</a>)(GSint iSubType,
|
||||
00182 GSchar *szText);
|
||||
00183
|
||||
00184
|
||||
00185 <span class="comment">//============================================================================</span>
|
||||
00186 <span class="comment">// Callback CBLoginRcv_LoginDisconnection</span>
|
||||
00187
|
||||
00195 <span class="comment">//============================================================================</span>
|
||||
<a name="l00196"></a><a class="code" href="group__group__LoginCB.html#a5">00196</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a5">CBLoginRcv_LoginDisconnection</a>)();
|
||||
00197
|
||||
00198
|
||||
00199 <span class="comment">//============================================================================</span>
|
||||
00200 <span class="comment">// Callback CBLoginRcv_AccountCreationResult</span>
|
||||
00201
|
||||
00227 <span class="comment">//============================================================================</span>
|
||||
<a name="l00228"></a><a class="code" href="group__group__LoginCB.html#a6">00228</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a6">CBLoginRcv_AccountCreationResult</a>)(GSubyte ubType,
|
||||
00229 GSint iReason);
|
||||
00230
|
||||
00231
|
||||
00232 <span class="comment">//============================================================================</span>
|
||||
00233 <span class="comment">// Callback CBLoginRcv_ModifyUserResult</span>
|
||||
00234
|
||||
00254 <span class="comment">//============================================================================</span>
|
||||
<a name="l00255"></a><a class="code" href="group__group__LoginCB.html#a7">00255</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a7">CBLoginRcv_ModifyUserResult</a>)(GSubyte ubType,
|
||||
00256 GSint iReason);
|
||||
00257
|
||||
00258
|
||||
00259 <span class="comment">//============================================================================</span>
|
||||
00260 <span class="comment">// Callback DBLoginRcv_RequestMOTD</span>
|
||||
00261
|
||||
00280 <span class="comment">//============================================================================</span>
|
||||
<a name="l00281"></a><a class="code" href="group__group__LoginCB.html#a8">00281</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__LoginCB.html#a8">CBLoginRcv_RequestMOTD</a>)(GSubyte ubType,
|
||||
00282 GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason);
|
||||
00283
|
||||
00286 <span class="preprocessor">#endif //__GSLOGINCB_H_</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,55 @@
|
||||
<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>GSLoginCB.h File Reference</h1>Callback functions for the Login service.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSLoginCB_8h-source.html">Go to the source code of this file.</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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a0">CBLoginRcv_PlayerInfo</a> )(GSubyte ubType, GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName, GSchar *szCountry, GSchar *szEmail, GSchar *szIRCID, GSchar *szIPAddress, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive information on a player. </em> <a href="group__group__LoginCB.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a1">CBLoginRcv_JoinWaitModuleResult</a> )(GSubyte ubType, GSchar *szAddress, GSushort usPort, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the join wait module request. </em> <a href="group__group__LoginCB.html#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the login request. </em> <a href="group__group__LoginCB.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a3">CBLoginRcv_LoginWaitModuleResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the login wait module request. </em> <a href="group__group__LoginCB.html#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a4">CBLoginRcv_SystemPage</a> )(GSint iSubType, GSchar *szText)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Received a system page. </em> <a href="group__group__LoginCB.html#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a5">CBLoginRcv_LoginDisconnection</a> )()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnection from router. </em> <a href="group__group__LoginCB.html#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a6">CBLoginRcv_AccountCreationResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the account creation request. </em> <a href="group__group__LoginCB.html#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a7">CBLoginRcv_ModifyUserResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the user modifycation request. </em> <a href="group__group__LoginCB.html#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a8">CBLoginRcv_RequestMOTD</a> )(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the message of the day. </em> <a href="group__group__LoginCB.html#a8"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file contains all callback functions declaration for the<b><em>login service</em></b>.<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>
|
||||
@@ -0,0 +1,70 @@
|
||||
<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>GSPersistentCB.h</h1><a href="GSPersistentCB_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
|
||||
00002 <span class="comment">//****************************************************************************</span>
|
||||
00003 <span class="comment">//* Author: Guillaume Plante <gsdevelopers@ubisoft.com></span>
|
||||
00004 <span class="comment">//* Date: 2001-09-20</span>
|
||||
00011 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00012
|
||||
00013 <span class="preprocessor">#ifndef _GSPersistentCB_H_</span>
|
||||
00014 <span class="preprocessor"></span><span class="preprocessor">#define _GSPersistentCB_H_</span>
|
||||
00015 <span class="preprocessor"></span>
|
||||
00016 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00017
|
||||
00018 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
00019 <span class="preprocessor"></span><span class="keyword">class </span>clPersistentCallbacks
|
||||
00020 {
|
||||
00021 <span class="keyword">public</span>:
|
||||
00022
|
||||
00023 <span class="keyword">virtual</span> GSvoid PSRcv_LoginResult(GSubyte ucType, GSint iReason) = 0;
|
||||
00024 <span class="keyword">virtual</span> GSvoid PSRcv_Disconnection() = 0;
|
||||
00025 <span class="keyword">virtual</span> GSvoid PSRcv_GetDataReply(GSubyte ucType, GSint iReason,GSuint iID,
|
||||
00026 GSvoid *pData,GSint iSize) = 0;
|
||||
00027 <span class="keyword">virtual</span> GSvoid PSRcv_SetDataReply(GSubyte ucType, GSint iReason,
|
||||
00028 GSuint iID) = 0;
|
||||
00029 };
|
||||
00030
|
||||
00031 <span class="preprocessor">#endif //__cplusplus</span>
|
||||
00032 <span class="preprocessor"></span>
|
||||
00037 <span class="comment">//============================================================================</span>
|
||||
00038 <span class="comment">// CallBack CBPSRcv_LoginResult </span>
|
||||
00039
|
||||
00052 <span class="comment">//============================================================================</span>
|
||||
<a name="l00053"></a><a class="code" href="group__group__PSCB.html#a0">00053</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a>)(GSubyte ucType, GSint iReason);
|
||||
00054
|
||||
00055 <span class="comment">//============================================================================</span>
|
||||
00056 <span class="comment">// CallBack CBPSRcv_Disconnection</span>
|
||||
00065 <span class="comment"></span><span class="comment">//============================================================================</span>
|
||||
<a name="l00066"></a><a class="code" href="group__group__PSCB.html#a1">00066</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a>)();
|
||||
00067
|
||||
00068
|
||||
00069 <span class="comment">//============================================================================</span>
|
||||
00070 <span class="comment">// CallBack CBPSRcv_SetDataReply</span>
|
||||
00071
|
||||
00083 <span class="comment">//============================================================================</span>
|
||||
<a name="l00084"></a><a class="code" href="group__group__PSCB.html#a2">00084</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a>)(GSubyte ucType, GSint iReason,
|
||||
00085 GSuint iID);
|
||||
00086
|
||||
00087 <span class="comment">//============================================================================</span>
|
||||
00088 <span class="comment">// CallBack CBPSRcv_GetDataReply</span>
|
||||
00089
|
||||
00104 <span class="comment">//============================================================================</span>
|
||||
<a name="l00105"></a><a class="code" href="group__group__PSCB.html#a3">00105</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a>)(GSubyte ucType, GSint iReason,
|
||||
00106 GSuint iID,GSvoid *pData,GSint iSize);
|
||||
00107
|
||||
00108 <span class="preprocessor">#endif //_GSPersistentCB_H_</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,40 @@
|
||||
<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>GSPersistentCB.h File Reference</h1>Callback functions for the <b><em>persistent storage service</em></b>.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="GSPersistentCB_8h-source.html">Go to the source code of this file.</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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a> )(GSubyte ucType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the Persistent data storage login request. </em> <a href="group__group__PSCB.html#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a> )()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Client as been disconnected from the Persistent storage service. </em> <a href="group__group__PSCB.html#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Proxy reply on client request to set persistent data. </em> <a href="group__group__PSCB.html#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID, GSvoid *pData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Proxy reply on client request to get persistent data. </em> <a href="group__group__PSCB.html#a3"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file contains all callback functions declaration for the persistent storage service.<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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<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>GSRemoteAlgorithmCB.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef __GSREMOTEALGORITHMCB_H__</span>
|
||||
00002 <span class="preprocessor"></span><span class="preprocessor">#define __GSREMOTEALGORITHMCB_H__</span>
|
||||
00003 <span class="preprocessor"></span>
|
||||
00004 <span class="comment">// remote algorithm execution service definitions</span>
|
||||
00005 <span class="preprocessor">#include "RemoteAlgorithmDefines.h"</span>
|
||||
00006
|
||||
00007 <span class="comment">// error code system</span>
|
||||
00008 <span class="preprocessor">#include "GSErrors.h"</span>
|
||||
00009
|
||||
00014 <span class="comment">//============================================================================</span>
|
||||
00015 <span class="comment">// Callback RemoteAlgorithm_OutputCB</span>
|
||||
00016
|
||||
00050 <span class="comment">//============================================================================</span>
|
||||
<a name="l00051"></a><a class="code" href="group__group__RAECB.html#a0">00051</a> <span class="keyword">typedef</span> GSvoid (__stdcall *<a class="code" href="group__group__RAECB.html#a0">RemoteAlgorithm_OutputCB</a>)(
|
||||
00052 <span class="keyword">const</span> GSvoid * pData, GSuint uiRequestId, GSRESULT rResult,
|
||||
00053 <span class="keyword">const</span> <a class="code" href="structRAE__VALUE.html">RAE_VALUE</a> * pOutput, GSuint uiNumOutput);
|
||||
00054
|
||||
00057 <span class="preprocessor">#endif // __GSREMOTEALGORITHMCB_H__</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,59 @@
|
||||
<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>LadderDefines.h</h1><a href="LadderDefines_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">//****************************************************************************</span>
|
||||
00002 <span class="comment">//* Author: Guillaume Plante</span>
|
||||
00008 <span class="comment"></span><span class="comment">//****************************************************************************</span>
|
||||
00009
|
||||
00010
|
||||
00011 <span class="preprocessor">#ifndef __LADDERDEFINES_H__</span>
|
||||
00012 <span class="preprocessor"></span><span class="preprocessor">#define __LADDERDEFINES_H__</span>
|
||||
00013 <span class="preprocessor"></span>
|
||||
00014 <span class="preprocessor">#include "define.h"</span>
|
||||
00015 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00016
|
||||
<a name="l00017"></a><a class="code" href="LadderDefines_8h.html#a0">00017</a> <span class="preprocessor">#define LADDER_QUERY_VERSION 1 </span>
|
||||
00018 <span class="preprocessor"></span>
|
||||
<a name="l00019"></a><a class="code" href="LadderDefines_8h.html#a1">00019</a> <span class="preprocessor"></span><span class="preprocessor">#define LADDER_NAME_LENGTH 1025 </span>
|
||||
<a name="l00020"></a><a class="code" href="LadderDefines_8h.html#a2">00020</a> <span class="preprocessor">#define LADDER_FIELDNAME_LENGTH 129 </span>
|
||||
<a name="l00021"></a><a class="code" href="LadderDefines_8h.html#a3">00021</a> <span class="preprocessor">#define LADDER_FIELDCAPTION_LENGTH 33 </span>
|
||||
<a name="l00022"></a><a class="code" href="LadderDefines_8h.html#a4">00022</a> <span class="preprocessor">#define LADDER_FIELDVALUE_LENGTH 129 </span>
|
||||
00023 <span class="preprocessor"></span>
|
||||
00024 <span class="preprocessor"></span>
|
||||
<a name="l00030"></a><a class="code" href="LadderDefines_8h.html#a8">00030</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>
|
||||
00031 {
|
||||
00032 FILTER_EQUAL,
|
||||
00033 FILTER_ABOVE,
|
||||
00034 FILTER_BELOW
|
||||
00035 } <a class="code" href="LadderDefines_8h.html#a8">E_FILTER_OPERATOR</a>;
|
||||
00036
|
||||
<a name="l00045"></a><a class="code" href="structLADDER__FILTER.html">00045</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
|
||||
00046 <span class="keyword"></span>{
|
||||
<a name="l00047"></a><a class="code" href="structLADDER__FILTER.html#o0">00047</a> GSchar szFieldName[<a class="code" href="LadderDefines_8h.html#a2">LADDER_FIELDNAME_LENGTH</a>];
|
||||
<a name="l00048"></a><a class="code" href="structLADDER__FILTER.html#o1">00048</a> <a class="code" href="LadderDefines_8h.html#a8">E_FILTER_OPERATOR</a> eOperator;
|
||||
<a name="l00049"></a><a class="code" href="structLADDER__FILTER.html#o2">00049</a> GSint iValue;
|
||||
00050 } <a class="code" href="structLADDER__FILTER.html">LADDER_FILTER</a>;
|
||||
00051
|
||||
00052
|
||||
<a name="l00060"></a><a class="code" href="structLADDER__ROW.html">00060</a> <span class="keyword">struct </span><a class="code" href="structLADDER__ROW.html">LADDER_ROW</a>
|
||||
00061 {
|
||||
00062 GSchar player[NAMELENGTH];
|
||||
00063 GSushort valueCount;
|
||||
00064 GSint * values;
|
||||
00065 };
|
||||
00066
|
||||
00067 <span class="preprocessor">#endif //__LADDERDEFINES_H__</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,86 @@
|
||||
<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>LadderDefines.h File Reference</h1>Definitions for the ladder query service.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include "define.h"</code><br>
|
||||
<code>#include "GSTypes.h"</code><br>
|
||||
|
||||
<p>
|
||||
<a href="LadderDefines_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Classes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ladder filter structure. </em> <a href="structLADDER__FILTER.html#_details">More...</a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structLADDER__ROW.html">LADDER_ROW</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ladder row representation. </em> <a href="structLADDER__ROW.html#_details">More...</a><em><br><br></td></tr>
|
||||
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="LadderDefines.h::LADDER_QUERY_VERSION" ></a>
|
||||
#define </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a0">LADDER_QUERY_VERSION</a> 1</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Version of the ladder query service. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="LadderDefines.h::LADDER_NAME_LENGTH" ></a>
|
||||
#define </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a1">LADDER_NAME_LENGTH</a> 1025</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of a string representing the ladder name. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="LadderDefines.h::LADDER_FIELDNAME_LENGTH" ></a>
|
||||
#define </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a2">LADDER_FIELDNAME_LENGTH</a> 129</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of a string representing a field name in the ladder. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="LadderDefines.h::LADDER_FIELDCAPTION_LENGTH" ></a>
|
||||
#define </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a3">LADDER_FIELDCAPTION_LENGTH</a> 33</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of a string representing a ladder field name. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="LadderDefines.h::LADDER_FIELDVALUE_LENGTH" ></a>
|
||||
#define </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a4">LADDER_FIELDVALUE_LENGTH</a> 129</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of a string representing a ladder field value. <br><br></td></tr>
|
||||
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="LadderDefines_8h.html#a8">E_FILTER_OPERATOR</a> { <b>FILTER_EQUAL</b>,
|
||||
<b>FILTER_ABOVE</b>,
|
||||
<b>FILTER_BELOW</b>
|
||||
}</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Filter operator enumeration. </em> <a href="#a8">More...</a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This file defines global values and structures for the ladder query service.<hr><h2>Enumeration Type Documentation</h2>
|
||||
<a class="anchor" name="a8" doxytag="LadderDefines.h::E_FILTER_OPERATOR" ></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"> enum <a class="el" href="LadderDefines_8h.html#a8">E_FILTER_OPERATOR</a>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
This enumeration contains the valid operators that are used in the <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> structure. </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>
|
||||
@@ -0,0 +1,126 @@
|
||||
<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>LobbyDefines.h</h1><div class="fragment"><pre>00001 <span class="comment">/***SDOC*******************************************************************************************</span>
|
||||
00002 <span class="comment"> * UbiSoft Network Development</span>
|
||||
00003 <span class="comment"> * ---------------------------</span>
|
||||
00004 <span class="comment"> *</span>
|
||||
00005 <span class="comment"> * FILE........: LobbyDefines.h</span>
|
||||
00006 <span class="comment"> * CREATION....: October 2001</span>
|
||||
00007 <span class="comment"> * AUTHOR......: GS Dev</span>
|
||||
00008 <span class="comment"> *</span>
|
||||
00009 <span class="comment"> * DESCRIPTION.: Miscelleanous definitions for the Lobby server </span>
|
||||
00010 <span class="comment"> *</span>
|
||||
00011 <span class="comment"> ******************************************************************************************EDOC***/</span>
|
||||
00012 <span class="preprocessor">#ifndef __LOBBYDEFINES_H__</span>
|
||||
00013 <span class="preprocessor"></span><span class="preprocessor">#define __LOBBYDEFINES_H__</span>
|
||||
00014 <span class="preprocessor"></span>
|
||||
00015 <span class="preprocessor">#include "GSTypes.h"</span>
|
||||
00016
|
||||
00017
|
||||
00018 <span class="comment">//-------------------- Group Type ------------------------------</span>
|
||||
00019 <span class="comment">// Constant ----> Name in gslobbyserver.conf</span>
|
||||
00020 <span class="keyword">const</span> GSushort LOBBY = 0; <span class="comment">//"LOBBY" </span>
|
||||
00021 <span class="keyword">const</span> GSushort ROOM_DIRECTPLAY_CLIENTSERVER = 1; <span class="comment">//"DIRECTPLAY_CLIENTSERVER"</span>
|
||||
00022 <span class="keyword">const</span> GSushort ROOM_DIRECTPLAY_P2P = 2; <span class="comment">//"DIRECTPLAY_P2P"</span>
|
||||
00023 <span class="keyword">const</span> GSushort ROOM_HYBRID = 3; <span class="comment">//"HYBRID"</span>
|
||||
00024 <span class="keyword">const</span> GSushort ROOM_HYBRID_REGSERVER = 4; <span class="comment">//"HYBRID_REGSERVER"</span>
|
||||
00025 <span class="keyword">const</span> GSushort ROOM_UBI_CLIENTHOST = 5; <span class="comment">//"UBI_CLIENTHOST"</span>
|
||||
00026 <span class="keyword">const</span> GSushort ROOM_UBI_CLIENTHOST_REGSERVER = 6; <span class="comment">//"UBI_CLIENTHOST_REGSERVER"</span>
|
||||
00027 <span class="keyword">const</span> GSushort ROOM_UBI_P2P = 7; <span class="comment">//"UBI_P2P"</span>
|
||||
00028 <span class="keyword">const</span> GSushort ROOM_UBI_GAMESERVER = 8; <span class="comment">//"UBI_GAMESERVER"</span>
|
||||
00029 <span class="keyword">const</span> GSushort ROOM_UBI_GAMESERVER_REGSERVER = 9; <span class="comment">//"UBI_GAMESERVER_REGSERVER"</span>
|
||||
00030 <span class="keyword">const</span> GSushort ROOM_REGSERVER = 10; <span class="comment">//"REGISTER_SERVER"</span>
|
||||
00031
|
||||
00032 <span class="comment">//------------------------ Group and Game Masks ------------------------------</span>
|
||||
00033 <span class="keyword">const</span> GSuint LSM_PRIVATE = 1 << 0; <span class="comment">//The group is protected by a password</span>
|
||||
00034 <span class="keyword">const</span> GSuint LSM_NEEDMASTER = 1 << 1; <span class="comment">//The group need a master </span>
|
||||
00035 <span class="keyword">const</span> GSuint LSM_ETERNEL = 1 << 2; <span class="comment">//The group is eternel ie when no player is on the group it is not deleted</span>
|
||||
00036 <span class="keyword">const</span> GSuint LSM_ACTIVE = 1 << 3; <span class="comment">//The game is started</span>
|
||||
00037 <span class="keyword">const</span> GSuint LSM_OPEN = 1 << 4; <span class="comment">//The group is open </span>
|
||||
00038 <span class="keyword">const</span> GSuint LSM_STARTABLE = 1 << 5; <span class="comment">//The group can be started </span>
|
||||
00039 <span class="keyword">const</span> GSuint LSM_MATCHACTIVE = 1 << 12; <span class="comment">//The match is started</span>
|
||||
00040
|
||||
00041 <span class="keyword">const</span> GSuint LSM_CREATE_SUBLOBBY = 1 << 9; <span class="comment">//Allow to create sublobby</span>
|
||||
00042 <span class="keyword">const</span> GSuint LSM_OPEN_WHEN_ACTIVE = 1 << 10; <span class="comment">//When the game is started the group is still open</span>
|
||||
00043 <span class="keyword">const</span> GSuint LSM_SCORES_SUBMISSION = 1 << 11; <span class="comment">//Allow score submission</span>
|
||||
00044 <span class="keyword">const</span> GSuint LSM_DEDICATEDSERVER = 1 << 14; <span class="comment">//The group represent a dedicated server </span>
|
||||
00045 <span class="keyword">const</span> GSuint LSM_REGISTERSERVER = 1 << 13;
|
||||
00046 <span class="keyword">const</span> GSuint LSM_JOINRULE = 1 << 15; <span class="comment">//The access to the group is protected by a rule ( use with passport )</span>
|
||||
00047 <span class="keyword">const</span> GSuint LSM_CREATERULE = 1 << 16; <span class="comment">//The group caretion is restricted by a rule ( use with passport )</span>
|
||||
00048
|
||||
00049
|
||||
00050 <span class="comment">//--------------- Join info Masks ----------------------------------------------------</span>
|
||||
00051 <span class="keyword">const</span> GSuint LSM_GROUPINFO = 1 << 6; <span class="comment">//Get the group info </span>
|
||||
00052 <span class="keyword">const</span> GSuint LSM_GROUPMEMBERS = 1 << 7; <span class="comment">//Get the group members </span>
|
||||
00053 <span class="keyword">const</span> GSuint LSM_CHILDGROUPINFO = 1 << 8; <span class="comment">//Get the childs group info</span>
|
||||
00054
|
||||
00055 <span class="keyword">const</span> GSuint LSM_ALLINFO = LSM_GROUPINFO | LSM_GROUPMEMBERS | LSM_CHILDGROUPINFO;
|
||||
00056
|
||||
00057 <span class="comment">//------------------- Player Status ----------------------------</span>
|
||||
00058 <span class="keyword">const</span> GSushort PS_SILENT = 1 << 0; <span class="comment">//The player is limited ( doesn't access to chat, page, etc ... )</span>
|
||||
00059 <span class="keyword">const</span> GSushort PS_GAMECONNECTED = 1 << 1; <span class="comment">//The player is playing a game</span>
|
||||
00060 <span class="keyword">const</span> GSushort PS_GAMEREADY = 1 << 2; <span class="comment">//not implemented yet</span>
|
||||
00061 <span class="keyword">const</span> GSushort PS_MATCHREADY = 1 << 3; <span class="comment">//not implemented yet </span>
|
||||
00062 <span class="keyword">const</span> GSushort PS_MATCHPLAYING = 1 << 4; <span class="comment">//The player is playing a match</span>
|
||||
00063
|
||||
00064 <span class="comment">//-------------------- error messages -------------------------</span>
|
||||
00065 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_UNKNOWNERROR = 0;
|
||||
00066 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GROUPNOTEXIST = 1;
|
||||
00067 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GAMENOTALLOWED = 2;
|
||||
00068 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_SPECTATORNOTALLOWED = 4;
|
||||
00069 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOMOREPLAYERS = 5;
|
||||
00070 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOMORESPECTATORS = 6;
|
||||
00071 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOMOREMEMBERS = 7;
|
||||
00072 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MEMBERNOTREGISTERED = 8;
|
||||
00073 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GAMEINPROGRESS = 9;
|
||||
00074 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_WRONGGAMEVERSION = 10;
|
||||
00075 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_PASSWORDNOTCORRECT = 11;
|
||||
00076 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_ALREADYINGROUP = 12;
|
||||
00077 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOTMASTER = 13;
|
||||
00078 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOTINGROUP = 14;
|
||||
00079 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MINPLAYERSNOTREACH = 15;
|
||||
00080 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_CONNECTADDCONNECTION = 16;
|
||||
00081 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_CONNECTSENDLOGINMSG = 17;
|
||||
00082 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_ERRORLOGINMESSAGE = 18;
|
||||
00083 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOHOSTLOBBYSERVER = 19;
|
||||
00084 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_LOBBYSRVDISCONNECTED = 20;
|
||||
00085 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_INVALIDGROUPNAME = 21;
|
||||
00086 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_INVALIDGAMETYPE = 22;
|
||||
00087 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOMOREGAMEMODULE = 23;
|
||||
00088 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_CREATENOTALLOWED = 24;
|
||||
00089 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GROUPCLOSE = 25;
|
||||
00090 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_WRONGGROUPTYPE = 26;
|
||||
00091 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MEMBERNOTFOUND = 27;
|
||||
00092 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHNOTEXIST = 30;
|
||||
00093 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHNOTFINISHED = 31;
|
||||
00094 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GAMENOTINITIATED = 32;
|
||||
00095 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_BEGINALREADYDONE = 33;
|
||||
00096 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHALREADYFINISHEDFORYOU = 34;
|
||||
00097 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHSCORESSUBMISSIONEVENTFAIL = 35;
|
||||
00098 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHSCORESSUBMISSIONALREDYSENT = 36;
|
||||
00099 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MATCHRESULTSPROCESSNOTFINISHED = 37;
|
||||
00100 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_MEMBERBANNED = 38;
|
||||
00101 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_PASSPORTFAIL = 39;
|
||||
00102 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_NOTCREATOR = 40;
|
||||
00103 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GAMENOTFINISHED = 41;
|
||||
00104 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_PASSPORTTIMEOUT = 42;
|
||||
00105 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_PASSPORTNOTFOUND = 43;
|
||||
00106 <span class="keyword">const</span> GSushort ERRORLOBBYSRV_GROUPALREADYEXIST = 44;
|
||||
00107
|
||||
00108 <span class="preprocessor">#endif</span>
|
||||
00109 <span class="preprocessor"></span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,34 @@
|
||||
<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>RemoteAlgorithmDefines.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef __REMOTEALGORITHMDEFINES_H__</span>
|
||||
00002 <span class="preprocessor"></span><span class="preprocessor">#define __REMOTEALGORITHMDEFINES_H__</span>
|
||||
00003 <span class="preprocessor"></span>
|
||||
00011 <span class="keyword">enum</span> RAE_DATATYPE {
|
||||
00012 RAE_INTEGER
|
||||
00013 };
|
||||
00014
|
||||
<a name="l00023"></a><a class="code" href="structRAE__VALUE.html">00023</a> <span class="keyword">struct </span><a class="code" href="structRAE__VALUE.html">RAE_VALUE</a>
|
||||
00024 {
|
||||
<a name="l00025"></a><a class="code" href="structRAE__VALUE.html#o0">00025</a> RAE_DATATYPE <a class="code" href="structRAE__VALUE.html#o0">dataType</a>;
|
||||
00026 <span class="keyword">union</span>
|
||||
00027 <span class="keyword"> </span>{
|
||||
<a name="l00028"></a><a class="code" href="structRAE__VALUE.html#o1">00028</a> GSint <a class="code" href="structRAE__VALUE.html#o1">intValue</a>;
|
||||
00029 };
|
||||
00030 };
|
||||
00031
|
||||
00032 <span class="preprocessor">#endif // __REMOTEALGORITHMDEFINES_H__</span>
|
||||
</pre></div><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>
|
||||
@@ -0,0 +1,22 @@
|
||||
<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="qindexHL" 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>gs-sdk-base Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
|
||||
<tr><td class="indexkey"><a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a></td><td class="indexvalue">Ladder filter structure </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="structLADDER__ROW.html">LADDER_ROW</a></td><td class="indexvalue">Ladder row representation </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="structRAE__VALUE.html">RAE_VALUE</a></td><td class="indexvalue">INPUT/OUTPUT Element </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>
|
||||
BIN
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/doxygen.png
Normal file
BIN
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/doxygen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
30
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/files.html
Normal file
30
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/files.html
Normal file
@@ -0,0 +1,30 @@
|
||||
<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="qindexHL" 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>gs-sdk-base File List</h1>Here is a list of all documented files with brief descriptions:<table>
|
||||
<tr><td class="indexkey"><b>GSClientClass.h</b> <a href="GSClientClass_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSClientLibrary_8h.html">GSClientLibrary.h</a> <a href="GSClientLibrary_8h-source.html">[code]</a></td><td class="indexvalue">Available functions for basic ubi.com services usage </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSFriendsCB_8h.html">GSFriendsCB.h</a> <a href="GSFriendsCB_8h-source.html">[code]</a></td><td class="indexvalue">Callback functions for the <b><em>friends service</em></b> </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSLadderQueryCB_8h.html">GSLadderQueryCB.h</a> <a href="GSLadderQueryCB_8h-source.html">[code]</a></td><td class="indexvalue">Callback functions for the <b><em>ladder query service</em></b> </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSLobbyCB_8h.html">GSLobbyCB.h</a> <a href="GSLobbyCB_8h-source.html">[code]</a></td><td class="indexvalue">Callback functions for the <b><em>lobby service</em></b> </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSLoginCB_8h.html">GSLoginCB.h</a> <a href="GSLoginCB_8h-source.html">[code]</a></td><td class="indexvalue">Callback functions for the Login service </td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="GSPersistentCB_8h.html">GSPersistentCB.h</a> <a href="GSPersistentCB_8h-source.html">[code]</a></td><td class="indexvalue">Callback functions for the <b><em>persistent storage service</em></b> </td></tr>
|
||||
<tr><td class="indexkey"><b>GSRemoteAlgorithmCB.h</b> <a href="GSRemoteAlgorithmCB_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
|
||||
<tr><td class="indexkey"><a class="el" href="LadderDefines_8h.html">LadderDefines.h</a> <a href="LadderDefines_8h-source.html">[code]</a></td><td class="indexvalue">Definitions for the ladder query service </td></tr>
|
||||
<tr><td class="indexkey"><b>LobbyDefines.h</b> <a href="LobbyDefines_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr>
|
||||
<tr><td class="indexkey"><b>RemoteAlgorithmDefines.h</b> <a href="RemoteAlgorithmDefines_8h-source.html">[code]</a></td><td class="indexvalue"></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>
|
||||
@@ -0,0 +1,27 @@
|
||||
<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="qindexHL" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindexHL" href="functions.html">All</a> | <a class="qindex" href="functions_vars.html">Variables</a></div>
|
||||
|
||||
<p>
|
||||
Here is a list of all documented class members with links to the class documentation for each member:<ul>
|
||||
<li>dataType
|
||||
: <a class="el" href="structRAE__VALUE.html#o0">RAE_VALUE</a><li>eOperator
|
||||
: <a class="el" href="structLADDER__FILTER.html#o1">LADDER_FILTER</a><li>intValue
|
||||
: <a class="el" href="structRAE__VALUE.html#o1">RAE_VALUE</a><li>iValue
|
||||
: <a class="el" href="structLADDER__FILTER.html#o2">LADDER_FILTER</a><li>szFieldName
|
||||
: <a class="el" href="structLADDER__FILTER.html#o0">LADDER_FILTER</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,27 @@
|
||||
<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="qindexHL" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindex" href="functions.html">All</a> | <a class="qindexHL" href="functions_vars.html">Variables</a></div>
|
||||
|
||||
<p>
|
||||
<ul>
|
||||
<li>dataType
|
||||
: <a class="el" href="structRAE__VALUE.html#o0">RAE_VALUE</a><li>eOperator
|
||||
: <a class="el" href="structLADDER__FILTER.html#o1">LADDER_FILTER</a><li>intValue
|
||||
: <a class="el" href="structRAE__VALUE.html#o1">RAE_VALUE</a><li>iValue
|
||||
: <a class="el" href="structLADDER__FILTER.html#o2">LADDER_FILTER</a><li>szFieldName
|
||||
: <a class="el" href="structLADDER__FILTER.html#o0">LADDER_FILTER</a></ul>
|
||||
<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>
|
||||
287
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/globals.html
Normal file
287
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/globals.html
Normal file
@@ -0,0 +1,287 @@
|
||||
<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="qindexHL" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindexHL" href="globals.html">All</a> | <a class="qindex" href="globals_func.html">Functions</a> | <a class="qindex" href="globals_type.html">Typedefs</a> | <a class="qindex" href="globals_enum.html">Enumerations</a> | <a class="qindex" href="globals_defs.html">Defines</a></div>
|
||||
<div class="qindex"><a class="qindex" href="#index_c">c</a> | <a class="qindex" href="#index_e">e</a> | <a class="qindex" href="#index_f">f</a> | <a class="qindex" href="#index_g">g</a> | <a class="qindex" href="#index_l">l</a> | <a class="qindex" href="#index_p">p</a> | <a class="qindex" href="#index_r">r</a></div>
|
||||
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Here is a list of all documented file members with links to the documentation:<h3><a class="anchor" name="index_c">- c -</a></h3><ul>
|
||||
<li>CBFriendsRcv_AddFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a1">GSFriendsCB.h</a><li>CBFriendsRcv_ChangeFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a11">GSFriendsCB.h</a><li>CBFriendsRcv_DelFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a2">GSFriendsCB.h</a><li>CBFriendsRcv_IgnoredPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a6">GSFriendsCB.h</a><li>CBFriendsRcv_IgnorePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a3">GSFriendsCB.h</a><li>CBFriendsRcv_ListIgnoredPlayers
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a5">GSFriendsCB.h</a><li>CBFriendsRcv_LoginResult
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a0">GSFriendsCB.h</a><li>CBFriendsRcv_Page
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a7">GSFriendsCB.h</a><li>CBFriendsRcv_PagePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a8">GSFriendsCB.h</a><li>CBFriendsRcv_PeerMsg
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a9">GSFriendsCB.h</a><li>CBFriendsRcv_PeerPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a10">GSFriendsCB.h</a><li>CBFriendsRcv_ScoreCard
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a15">GSFriendsCB.h</a><li>CBFriendsRcv_SearchPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a14">GSFriendsCB.h</a><li>CBFriendsRcv_StatusChange
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a12">GSFriendsCB.h</a><li>CBFriendsRcv_UnignorePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a4">GSFriendsCB.h</a><li>CBFriendsRcv_UpdateFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a13">GSFriendsCB.h</a><li>CBLadderQueryRcv_RequestReply
|
||||
: <a class="el" href="GSLadderQueryCB_8h.html#a0">GSLadderQueryCB.h</a><li>CBLobbyRcv_CreateRoomReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a3">GSLobbyCB.h</a><li>CBLobbyRcv_FinalMatchResults
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a43">GSLobbyCB.h</a><li>CBLobbyRcv_GameReadyReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a29">GSLobbyCB.h</a><li>CBLobbyRcv_GameStarted
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a30">GSLobbyCB.h</a><li>CBLobbyRcv_GetAlternateGroupInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a21">GSLobbyCB.h</a><li>CBLobbyRcv_GroupConfigUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a23">GSLobbyCB.h</a><li>CBLobbyRcv_GroupInfoGet
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a8">GSLobbyCB.h</a><li>CBLobbyRcv_GroupLeaveReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a22">GSLobbyCB.h</a><li>CBLobbyRcv_GroupRemove
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a9">GSLobbyCB.h</a><li>CBLobbyRcv_InfoRefresh
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a38">GSLobbyCB.h</a><li>CBLobbyRcv_JoinLobbyReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a11">GSLobbyCB.h</a><li>CBLobbyRcv_JoinRoomReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a10">GSLobbyCB.h</a><li>CBLobbyRcv_KickOut
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a19">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyDisconnectAll
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a2">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyDisconnection
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a1">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyInfo
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a7">GSLobbyCB.h</a><li>CBLobbyRcv_LoginReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a0">GSLobbyCB.h</a><li>CBLobbyRcv_MasterChanged
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a15">GSLobbyCB.h</a><li>CBLobbyRcv_MasterNewReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a16">GSLobbyCB.h</a><li>CBLobbyRcv_MatchFinishReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a17">GSLobbyCB.h</a><li>CBLobbyRcv_MatchReady
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a37">GSLobbyCB.h</a><li>CBLobbyRcv_MatchStarted
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a24">GSLobbyCB.h</a><li>CBLobbyRcv_MemberJoined
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a12">GSLobbyCB.h</a><li>CBLobbyRcv_MemberLeave
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a13">GSLobbyCB.h</a><li>CBLobbyRcv_NewGameMember
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a31">GSLobbyCB.h</a><li>CBLobbyRcv_NewLobby
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a5">GSLobbyCB.h</a><li>CBLobbyRcv_NewRoom
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a4">GSLobbyCB.h</a><li>CBLobbyRcv_ParentGroupIDReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a20">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanList
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a35">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanned
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a36">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a33">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerGroupList
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a42">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerInfoUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a40">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerKickReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a18">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerStatusUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a41">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerUnBanReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a34">GSLobbyCB.h</a><li>CBLobbyRcv_RoomInfo
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a6">GSLobbyCB.h</a><li>CBLobbyRcv_SetPlayerInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a39">GSLobbyCB.h</a><li>CBLobbyRcv_StartGameReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a28">GSLobbyCB.h</a><li>CBLobbyRcv_StartMatchReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a14">GSLobbyCB.h</a><li>CBLobbyRcv_SubmitMatchResultReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a26">GSLobbyCB.h</a><li>CBLobbyRcv_UpdateGameInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a32">GSLobbyCB.h</a><li>CBLobbyRcv_UpdatePing
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a27">GSLobbyCB.h</a><li>CBLobbyRcv_UpdateRoomConfigReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a25">GSLobbyCB.h</a><li>CBLoginRcv_AccountCreationResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a6">GSLoginCB.h</a><li>CBLoginRcv_JoinWaitModuleResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a1">GSLoginCB.h</a><li>CBLoginRcv_LoginDisconnection
|
||||
: <a class="el" href="GSLoginCB_8h.html#a5">GSLoginCB.h</a><li>CBLoginRcv_LoginRouterResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a2">GSLoginCB.h</a><li>CBLoginRcv_LoginWaitModuleResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a3">GSLoginCB.h</a><li>CBLoginRcv_ModifyUserResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a7">GSLoginCB.h</a><li>CBLoginRcv_PlayerInfo
|
||||
: <a class="el" href="GSLoginCB_8h.html#a0">GSLoginCB.h</a><li>CBLoginRcv_RequestMOTD
|
||||
: <a class="el" href="GSLoginCB_8h.html#a8">GSLoginCB.h</a><li>CBLoginRcv_SystemPage
|
||||
: <a class="el" href="GSLoginCB_8h.html#a4">GSLoginCB.h</a><li>CBPSRcv_Disconnection
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a1">GSPersistentCB.h</a><li>CBPSRcv_GetDataReply
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a3">GSPersistentCB.h</a><li>CBPSRcv_LoginResult
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a0">GSPersistentCB.h</a><li>CBPSRcv_SetDataReply
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a2">GSPersistentCB.h</a></ul>
|
||||
<h3><a class="anchor" name="index_e">- e -</a></h3><ul>
|
||||
<li>E_FILTER_OPERATOR
|
||||
: <a class="el" href="LadderDefines_8h.html#a8">LadderDefines.h</a></ul>
|
||||
<h3><a class="anchor" name="index_f">- f -</a></h3><ul>
|
||||
<li>Friends_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>FriendsFix_AddFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>FriendsFix_ChangeFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>FriendsFix_DelFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>FriendsFix_IgnoredPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>FriendsFix_IgnorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>FriendsFix_ListIgnoredPlayers()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>FriendsFix_LoginResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>FriendsFix_Page()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>FriendsFix_PagePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>FriendsFix_PeerMsg()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>FriendsFix_PeerPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>FriendsFix_ScoreCard()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>FriendsFix_SearchPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>FriendsFix_StatusChange()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>FriendsFix_UnignorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>FriendsFix_UpdateFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>FriendsSend_AddFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>FriendsSend_ChangeFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>FriendsSend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>FriendsSend_DelFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>FriendsSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>FriendsSend_FriendList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>FriendsSend_GetPlayerScores()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>FriendsSend_IgnorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>FriendsSend_ListIgnoredPlayers()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>FriendsSend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>FriendsSend_PagePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>FriendsSend_PeerPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>FriendsSend_SearchPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>FriendsSend_StatusChange()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>FriendsSend_UnignorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_g">- g -</a></h3><ul>
|
||||
<li>GSClientLibrary_Initialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>GSClientLibrary_Uninitialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>GSGetLocalIPAddress()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_l">- l -</a></h3><ul>
|
||||
<li>LADDER_FIELDCAPTION_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a3">LadderDefines.h</a><li>LADDER_FIELDNAME_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a2">LadderDefines.h</a><li>LADDER_FIELDVALUE_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a4">LadderDefines.h</a><li>LADDER_NAME_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a1">LadderDefines.h</a><li>LADDER_QUERY_VERSION
|
||||
: <a class="el" href="LadderDefines_8h.html#a0">LadderDefines.h</a><li>LadderQuery_AddDisplayConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LadderQuery_AddFilterConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LadderQuery_AddSortConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LadderQuery_CreateRequest()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LadderQuery_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LadderQuery_GetCurrentEntryField()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LadderQuery_GetCurrentEntryFieldAsString()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LadderQuery_GetResultEntryCount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LadderQuery_GetResultFieldCaption()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LadderQuery_GetResultSearchCount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LadderQuery_Initialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LadderQuery_NextResultEntry()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LadderQuery_ReleaseResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LadderQuery_RequestOrderedList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LadderQuery_RequestPivotRow()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LadderQuery_RequestPivotUser()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LadderQuery_RequestSet()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LadderQuery_SendRequest()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LadderQuery_StartResultEntryEnumeration()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LadderQuery_Uninitialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LadderQueryFix_RequestReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>Lobby_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LobbyFix_CreateRoomReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LobbyFix_GameReadyReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a29">GSClientLibrary.h</a><li>LobbyFix_GameStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a30">GSClientLibrary.h</a><li>LobbyFix_GameStartReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a28">GSClientLibrary.h</a><li>LobbyFix_GetAlternateGroupInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a21">GSClientLibrary.h</a><li>LobbyFix_GroupConfigUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a23">GSClientLibrary.h</a><li>LobbyFix_GroupInfoGet()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LobbyFix_GroupLeaveReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a22">GSClientLibrary.h</a><li>LobbyFix_GroupRemove()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>LobbyFix_InfoRefresh()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a38">GSClientLibrary.h</a><li>LobbyFix_JoinLobbyReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LobbyFix_JoinRoomReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LobbyFix_KickOut()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a19">GSClientLibrary.h</a><li>LobbyFix_LobbyDisconnectAll()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LobbyFix_LobbyDisconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LobbyFix_LobbyInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LobbyFix_LoginReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LobbyFix_MasterChanged()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a16">GSClientLibrary.h</a><li>LobbyFix_MasterNewReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>LobbyFix_MatchFinishReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a17">GSClientLibrary.h</a><li>LobbyFix_MatchReady()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a37">GSClientLibrary.h</a><li>LobbyFix_MatchStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a24">GSClientLibrary.h</a><li>LobbyFix_MemberJoined()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LobbyFix_MemberLeave()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>LobbyFix_NewGameMember()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a31">GSClientLibrary.h</a><li>LobbyFix_NewLobby()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LobbyFix_NewRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LobbyFix_ParentGroupIDReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a20">GSClientLibrary.h</a><li>LobbyFix_PlayerBanList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a35">GSClientLibrary.h</a><li>LobbyFix_PlayerBanned()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a36">GSClientLibrary.h</a><li>LobbyFix_PlayerBanReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a33">GSClientLibrary.h</a><li>LobbyFix_PlayerGroupList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a41">GSClientLibrary.h</a><li>LobbyFix_PlayerInfoUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a40">GSClientLibrary.h</a><li>LobbyFix_PlayerKickReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a18">GSClientLibrary.h</a><li>LobbyFix_PlayerStatusUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a42">GSClientLibrary.h</a><li>LobbyFix_PlayerUnBanReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a34">GSClientLibrary.h</a><li>LobbyFix_RoomInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LobbyFix_SetPlayerInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a39">GSClientLibrary.h</a><li>LobbyFix_StartMatchReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>LobbyFix_SubmitMatchResultReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a26">GSClientLibrary.h</a><li>LobbyFix_UpdateGameInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a32">GSClientLibrary.h</a><li>LobbyFix_UpdatePing()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a27">GSClientLibrary.h</a><li>LobbyFix_UpdateRoomConfigReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a25">GSClientLibrary.h</a><li>LobbySend_ChangeRequestedLobbies()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a34">GSClientLibrary.h</a><li>LobbySend_ClearMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a22">GSClientLibrary.h</a><li>LobbySend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LobbySend_CreateRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LobbySend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LobbySend_DisconnectAll()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LobbySend_GameConnected()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a25">GSClientLibrary.h</a><li>LobbySend_GameFinish()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a26">GSClientLibrary.h</a><li>LobbySend_GameReady()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a27">GSClientLibrary.h</a><li>LobbySend_GameStart()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a24">GSClientLibrary.h</a><li>LobbySend_GetAlternateGroupInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a18">GSClientLibrary.h</a><li>LobbySend_GetGroupInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a17">GSClientLibrary.h</a><li>LobbySend_GetParentGroupID()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>LobbySend_GetPlayerBannedList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a31">GSClientLibrary.h</a><li>LobbySend_GetPlayerGroups()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a33">GSClientLibrary.h</a><li>LobbySend_InitMatchResults()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a19">GSClientLibrary.h</a><li>LobbySend_JoinLobby()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LobbySend_JoinRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LobbySend_LeaveGroup()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LobbySend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LobbySend_MatchFinish()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LobbySend_NewMaster()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LobbySend_PlayerBan()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a29">GSClientLibrary.h</a><li>LobbySend_PlayerKick()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>LobbySend_PlayerMatchFinished()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>LobbySend_PlayerMatchStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>LobbySend_PlayerUnBan()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a30">GSClientLibrary.h</a><li>LobbySend_SetMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a20">GSClientLibrary.h</a><li>LobbySend_SetPlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a32">GSClientLibrary.h</a><li>LobbySend_StartMatch()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LobbySend_SubmitMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a21">GSClientLibrary.h</a><li>LobbySend_UpdateGameInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a28">GSClientLibrary.h</a><li>LobbySend_UpdatePing()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a23">GSClientLibrary.h</a><li>LobbySend_UpdateRoomConfig()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a16">GSClientLibrary.h</a><li>Login_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LoginFix_JoinWaitModuleResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LoginFix_LoginAccountCreationResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LoginFix_LoginDisconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LoginFix_LoginRouterResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LoginFix_LoginWaitModuleResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LoginFix_ModifyUserResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LoginFix_PlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LoginFix_RequestMOTD()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LoginFix_SystemPage()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LoginSend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LoginSend_CreateAccount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LoginSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LoginSend_JoinWaitModule()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LoginSend_LoginRouter()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LoginSend_LoginWaitModule()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LoginSend_ModifyAccount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LoginSend_PlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LoginSend_RequestMOTD()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LoginSend_Sleep()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LoginSend_WakeUp()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_p">- p -</a></h3><ul>
|
||||
<li>PS_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>PSFix_Disconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>PSFix_GetDataReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>PSFix_LoginResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>PSFix_SetDataReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>PSSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>PSSend_GetPrivateData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>PSSend_GetPublicData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>PSSend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>PSSend_SetPrivateData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>PSSend_SetPublicData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_r">- r -</a></h3><ul>
|
||||
<li>RemoteAlgorithm_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>RemoteAlgorithm_Execute()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>RemoteAlgorithm_Initialise()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>RemoteAlgorithm_Uninitialise()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,27 @@
|
||||
<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="qindexHL" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindex" href="globals.html">All</a> | <a class="qindex" href="globals_func.html">Functions</a> | <a class="qindex" href="globals_type.html">Typedefs</a> | <a class="qindex" href="globals_enum.html">Enumerations</a> | <a class="qindexHL" href="globals_defs.html">Defines</a></div>
|
||||
|
||||
<p>
|
||||
<ul>
|
||||
<li>LADDER_FIELDCAPTION_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a3">LadderDefines.h</a><li>LADDER_FIELDNAME_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a2">LadderDefines.h</a><li>LADDER_FIELDVALUE_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a4">LadderDefines.h</a><li>LADDER_NAME_LENGTH
|
||||
: <a class="el" href="LadderDefines_8h.html#a1">LadderDefines.h</a><li>LADDER_QUERY_VERSION
|
||||
: <a class="el" href="LadderDefines_8h.html#a0">LadderDefines.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,23 @@
|
||||
<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="qindexHL" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindex" href="globals.html">All</a> | <a class="qindex" href="globals_func.html">Functions</a> | <a class="qindex" href="globals_type.html">Typedefs</a> | <a class="qindexHL" href="globals_enum.html">Enumerations</a> | <a class="qindex" href="globals_defs.html">Defines</a></div>
|
||||
|
||||
<p>
|
||||
<ul>
|
||||
<li>E_FILTER_OPERATOR
|
||||
: <a class="el" href="LadderDefines_8h.html#a8">LadderDefines.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,203 @@
|
||||
<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="qindexHL" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindex" href="globals.html">All</a> | <a class="qindexHL" href="globals_func.html">Functions</a> | <a class="qindex" href="globals_type.html">Typedefs</a> | <a class="qindex" href="globals_enum.html">Enumerations</a> | <a class="qindex" href="globals_defs.html">Defines</a></div>
|
||||
<div class="qindex"><a class="qindex" href="#index_f">f</a> | <a class="qindex" href="#index_g">g</a> | <a class="qindex" href="#index_l">l</a> | <a class="qindex" href="#index_p">p</a> | <a class="qindex" href="#index_r">r</a></div>
|
||||
|
||||
<p>
|
||||
|
||||
<p>
|
||||
<h3><a class="anchor" name="index_f">- f -</a></h3><ul>
|
||||
<li>Friends_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>FriendsFix_AddFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>FriendsFix_ChangeFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>FriendsFix_DelFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>FriendsFix_IgnoredPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>FriendsFix_IgnorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>FriendsFix_ListIgnoredPlayers()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>FriendsFix_LoginResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>FriendsFix_Page()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>FriendsFix_PagePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>FriendsFix_PeerMsg()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>FriendsFix_PeerPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>FriendsFix_ScoreCard()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>FriendsFix_SearchPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>FriendsFix_StatusChange()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>FriendsFix_UnignorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>FriendsFix_UpdateFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>FriendsSend_AddFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>FriendsSend_ChangeFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>FriendsSend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>FriendsSend_DelFriend()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>FriendsSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>FriendsSend_FriendList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>FriendsSend_GetPlayerScores()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>FriendsSend_IgnorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>FriendsSend_ListIgnoredPlayers()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>FriendsSend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>FriendsSend_PagePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>FriendsSend_PeerPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>FriendsSend_SearchPlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>FriendsSend_StatusChange()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>FriendsSend_UnignorePlayer()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_g">- g -</a></h3><ul>
|
||||
<li>GSClientLibrary_Initialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>GSClientLibrary_Uninitialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>GSGetLocalIPAddress()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_l">- l -</a></h3><ul>
|
||||
<li>LadderQuery_AddDisplayConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LadderQuery_AddFilterConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LadderQuery_AddSortConstraint()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LadderQuery_CreateRequest()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LadderQuery_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LadderQuery_GetCurrentEntryField()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LadderQuery_GetCurrentEntryFieldAsString()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LadderQuery_GetResultEntryCount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LadderQuery_GetResultFieldCaption()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LadderQuery_GetResultSearchCount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LadderQuery_Initialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LadderQuery_NextResultEntry()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LadderQuery_ReleaseResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LadderQuery_RequestOrderedList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LadderQuery_RequestPivotRow()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LadderQuery_RequestPivotUser()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LadderQuery_RequestSet()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LadderQuery_SendRequest()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LadderQuery_StartResultEntryEnumeration()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LadderQuery_Uninitialize()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LadderQueryFix_RequestReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>Lobby_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LobbyFix_CreateRoomReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LobbyFix_GameReadyReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a29">GSClientLibrary.h</a><li>LobbyFix_GameStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a30">GSClientLibrary.h</a><li>LobbyFix_GameStartReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a28">GSClientLibrary.h</a><li>LobbyFix_GetAlternateGroupInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a21">GSClientLibrary.h</a><li>LobbyFix_GroupConfigUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a23">GSClientLibrary.h</a><li>LobbyFix_GroupInfoGet()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LobbyFix_GroupLeaveReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a22">GSClientLibrary.h</a><li>LobbyFix_GroupRemove()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>LobbyFix_InfoRefresh()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a38">GSClientLibrary.h</a><li>LobbyFix_JoinLobbyReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LobbyFix_JoinRoomReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LobbyFix_KickOut()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a19">GSClientLibrary.h</a><li>LobbyFix_LobbyDisconnectAll()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LobbyFix_LobbyDisconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LobbyFix_LobbyInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LobbyFix_LoginReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LobbyFix_MasterChanged()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a16">GSClientLibrary.h</a><li>LobbyFix_MasterNewReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>LobbyFix_MatchFinishReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a17">GSClientLibrary.h</a><li>LobbyFix_MatchReady()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a37">GSClientLibrary.h</a><li>LobbyFix_MatchStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a24">GSClientLibrary.h</a><li>LobbyFix_MemberJoined()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LobbyFix_MemberLeave()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>LobbyFix_NewGameMember()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a31">GSClientLibrary.h</a><li>LobbyFix_NewLobby()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LobbyFix_NewRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LobbyFix_ParentGroupIDReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a20">GSClientLibrary.h</a><li>LobbyFix_PlayerBanList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a35">GSClientLibrary.h</a><li>LobbyFix_PlayerBanned()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a36">GSClientLibrary.h</a><li>LobbyFix_PlayerBanReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a33">GSClientLibrary.h</a><li>LobbyFix_PlayerGroupList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a41">GSClientLibrary.h</a><li>LobbyFix_PlayerInfoUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a40">GSClientLibrary.h</a><li>LobbyFix_PlayerKickReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a18">GSClientLibrary.h</a><li>LobbyFix_PlayerStatusUpdate()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a42">GSClientLibrary.h</a><li>LobbyFix_PlayerUnBanReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a34">GSClientLibrary.h</a><li>LobbyFix_RoomInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LobbyFix_SetPlayerInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a39">GSClientLibrary.h</a><li>LobbyFix_StartMatchReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>LobbyFix_SubmitMatchResultReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a26">GSClientLibrary.h</a><li>LobbyFix_UpdateGameInfoReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a32">GSClientLibrary.h</a><li>LobbyFix_UpdatePing()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a27">GSClientLibrary.h</a><li>LobbyFix_UpdateRoomConfigReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a25">GSClientLibrary.h</a><li>LobbySend_ChangeRequestedLobbies()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a34">GSClientLibrary.h</a><li>LobbySend_ClearMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a22">GSClientLibrary.h</a><li>LobbySend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LobbySend_CreateRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LobbySend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LobbySend_DisconnectAll()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LobbySend_GameConnected()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a25">GSClientLibrary.h</a><li>LobbySend_GameFinish()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a26">GSClientLibrary.h</a><li>LobbySend_GameReady()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a27">GSClientLibrary.h</a><li>LobbySend_GameStart()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a24">GSClientLibrary.h</a><li>LobbySend_GetAlternateGroupInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a18">GSClientLibrary.h</a><li>LobbySend_GetGroupInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a17">GSClientLibrary.h</a><li>LobbySend_GetParentGroupID()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a15">GSClientLibrary.h</a><li>LobbySend_GetPlayerBannedList()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a31">GSClientLibrary.h</a><li>LobbySend_GetPlayerGroups()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a33">GSClientLibrary.h</a><li>LobbySend_InitMatchResults()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a19">GSClientLibrary.h</a><li>LobbySend_JoinLobby()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LobbySend_JoinRoom()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LobbySend_LeaveGroup()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LobbySend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LobbySend_MatchFinish()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LobbySend_NewMaster()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LobbySend_PlayerBan()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a29">GSClientLibrary.h</a><li>LobbySend_PlayerKick()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a14">GSClientLibrary.h</a><li>LobbySend_PlayerMatchFinished()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a13">GSClientLibrary.h</a><li>LobbySend_PlayerMatchStarted()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a12">GSClientLibrary.h</a><li>LobbySend_PlayerUnBan()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a30">GSClientLibrary.h</a><li>LobbySend_SetMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a20">GSClientLibrary.h</a><li>LobbySend_SetPlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a32">GSClientLibrary.h</a><li>LobbySend_StartMatch()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LobbySend_SubmitMatchResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a21">GSClientLibrary.h</a><li>LobbySend_UpdateGameInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a28">GSClientLibrary.h</a><li>LobbySend_UpdatePing()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a23">GSClientLibrary.h</a><li>LobbySend_UpdateRoomConfig()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a16">GSClientLibrary.h</a><li>Login_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LoginFix_JoinWaitModuleResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LoginFix_LoginAccountCreationResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LoginFix_LoginDisconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LoginFix_LoginRouterResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LoginFix_LoginWaitModuleResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LoginFix_ModifyUserResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LoginFix_PlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>LoginFix_RequestMOTD()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a><li>LoginFix_SystemPage()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LoginSend_Connect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>LoginSend_CreateAccount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a10">GSClientLibrary.h</a><li>LoginSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>LoginSend_JoinWaitModule()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>LoginSend_LoginRouter()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>LoginSend_LoginWaitModule()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>LoginSend_ModifyAccount()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a9">GSClientLibrary.h</a><li>LoginSend_PlayerInfo()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a><li>LoginSend_RequestMOTD()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a11">GSClientLibrary.h</a><li>LoginSend_Sleep()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a7">GSClientLibrary.h</a><li>LoginSend_WakeUp()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a8">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_p">- p -</a></h3><ul>
|
||||
<li>PS_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>PSFix_Disconnection()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>PSFix_GetDataReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>PSFix_LoginResult()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>PSFix_SetDataReply()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>PSSend_Disconnect()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a><li>PSSend_GetPrivateData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>PSSend_GetPublicData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a5">GSClientLibrary.h</a><li>PSSend_Login()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>PSSend_SetPrivateData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a4">GSClientLibrary.h</a><li>PSSend_SetPublicData()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a6">GSClientLibrary.h</a></ul>
|
||||
<h3><a class="anchor" name="index_r">- r -</a></h3><ul>
|
||||
<li>RemoteAlgorithm_Engine()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a2">GSClientLibrary.h</a><li>RemoteAlgorithm_Execute()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a3">GSClientLibrary.h</a><li>RemoteAlgorithm_Initialise()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary.h</a><li>RemoteAlgorithm_Uninitialise()
|
||||
: <a class="el" href="GSClientLibrary_8h.html#a1">GSClientLibrary.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,99 @@
|
||||
<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="qindexHL" href="globals.html">File Members</a></div>
|
||||
<div class="qindex"><a class="qindex" href="globals.html">All</a> | <a class="qindex" href="globals_func.html">Functions</a> | <a class="qindexHL" href="globals_type.html">Typedefs</a> | <a class="qindex" href="globals_enum.html">Enumerations</a> | <a class="qindex" href="globals_defs.html">Defines</a></div>
|
||||
<div class="qindex"><a class="qindex" href="#index_c">c</a></div>
|
||||
|
||||
<p>
|
||||
|
||||
<p>
|
||||
<h3><a class="anchor" name="index_c">- c -</a></h3><ul>
|
||||
<li>CBFriendsRcv_AddFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a1">GSFriendsCB.h</a><li>CBFriendsRcv_ChangeFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a11">GSFriendsCB.h</a><li>CBFriendsRcv_DelFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a2">GSFriendsCB.h</a><li>CBFriendsRcv_IgnoredPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a6">GSFriendsCB.h</a><li>CBFriendsRcv_IgnorePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a3">GSFriendsCB.h</a><li>CBFriendsRcv_ListIgnoredPlayers
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a5">GSFriendsCB.h</a><li>CBFriendsRcv_LoginResult
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a0">GSFriendsCB.h</a><li>CBFriendsRcv_Page
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a7">GSFriendsCB.h</a><li>CBFriendsRcv_PagePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a8">GSFriendsCB.h</a><li>CBFriendsRcv_PeerMsg
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a9">GSFriendsCB.h</a><li>CBFriendsRcv_PeerPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a10">GSFriendsCB.h</a><li>CBFriendsRcv_ScoreCard
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a15">GSFriendsCB.h</a><li>CBFriendsRcv_SearchPlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a14">GSFriendsCB.h</a><li>CBFriendsRcv_StatusChange
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a12">GSFriendsCB.h</a><li>CBFriendsRcv_UnignorePlayer
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a4">GSFriendsCB.h</a><li>CBFriendsRcv_UpdateFriend
|
||||
: <a class="el" href="GSFriendsCB_8h.html#a13">GSFriendsCB.h</a><li>CBLadderQueryRcv_RequestReply
|
||||
: <a class="el" href="GSLadderQueryCB_8h.html#a0">GSLadderQueryCB.h</a><li>CBLobbyRcv_CreateRoomReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a3">GSLobbyCB.h</a><li>CBLobbyRcv_FinalMatchResults
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a43">GSLobbyCB.h</a><li>CBLobbyRcv_GameReadyReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a29">GSLobbyCB.h</a><li>CBLobbyRcv_GameStarted
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a30">GSLobbyCB.h</a><li>CBLobbyRcv_GetAlternateGroupInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a21">GSLobbyCB.h</a><li>CBLobbyRcv_GroupConfigUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a23">GSLobbyCB.h</a><li>CBLobbyRcv_GroupInfoGet
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a8">GSLobbyCB.h</a><li>CBLobbyRcv_GroupLeaveReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a22">GSLobbyCB.h</a><li>CBLobbyRcv_GroupRemove
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a9">GSLobbyCB.h</a><li>CBLobbyRcv_InfoRefresh
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a38">GSLobbyCB.h</a><li>CBLobbyRcv_JoinLobbyReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a11">GSLobbyCB.h</a><li>CBLobbyRcv_JoinRoomReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a10">GSLobbyCB.h</a><li>CBLobbyRcv_KickOut
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a19">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyDisconnectAll
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a2">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyDisconnection
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a1">GSLobbyCB.h</a><li>CBLobbyRcv_LobbyInfo
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a7">GSLobbyCB.h</a><li>CBLobbyRcv_LoginReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a0">GSLobbyCB.h</a><li>CBLobbyRcv_MasterChanged
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a15">GSLobbyCB.h</a><li>CBLobbyRcv_MasterNewReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a16">GSLobbyCB.h</a><li>CBLobbyRcv_MatchFinishReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a17">GSLobbyCB.h</a><li>CBLobbyRcv_MatchReady
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a37">GSLobbyCB.h</a><li>CBLobbyRcv_MatchStarted
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a24">GSLobbyCB.h</a><li>CBLobbyRcv_MemberJoined
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a12">GSLobbyCB.h</a><li>CBLobbyRcv_MemberLeave
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a13">GSLobbyCB.h</a><li>CBLobbyRcv_NewGameMember
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a31">GSLobbyCB.h</a><li>CBLobbyRcv_NewLobby
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a5">GSLobbyCB.h</a><li>CBLobbyRcv_NewRoom
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a4">GSLobbyCB.h</a><li>CBLobbyRcv_ParentGroupIDReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a20">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanList
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a35">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanned
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a36">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerBanReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a33">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerGroupList
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a42">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerInfoUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a40">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerKickReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a18">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerStatusUpdate
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a41">GSLobbyCB.h</a><li>CBLobbyRcv_PlayerUnBanReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a34">GSLobbyCB.h</a><li>CBLobbyRcv_RoomInfo
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a6">GSLobbyCB.h</a><li>CBLobbyRcv_SetPlayerInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a39">GSLobbyCB.h</a><li>CBLobbyRcv_StartGameReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a28">GSLobbyCB.h</a><li>CBLobbyRcv_StartMatchReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a14">GSLobbyCB.h</a><li>CBLobbyRcv_SubmitMatchResultReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a26">GSLobbyCB.h</a><li>CBLobbyRcv_UpdateGameInfoReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a32">GSLobbyCB.h</a><li>CBLobbyRcv_UpdatePing
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a27">GSLobbyCB.h</a><li>CBLobbyRcv_UpdateRoomConfigReply
|
||||
: <a class="el" href="GSLobbyCB_8h.html#a25">GSLobbyCB.h</a><li>CBLoginRcv_AccountCreationResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a6">GSLoginCB.h</a><li>CBLoginRcv_JoinWaitModuleResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a1">GSLoginCB.h</a><li>CBLoginRcv_LoginDisconnection
|
||||
: <a class="el" href="GSLoginCB_8h.html#a5">GSLoginCB.h</a><li>CBLoginRcv_LoginRouterResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a2">GSLoginCB.h</a><li>CBLoginRcv_LoginWaitModuleResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a3">GSLoginCB.h</a><li>CBLoginRcv_ModifyUserResult
|
||||
: <a class="el" href="GSLoginCB_8h.html#a7">GSLoginCB.h</a><li>CBLoginRcv_PlayerInfo
|
||||
: <a class="el" href="GSLoginCB_8h.html#a0">GSLoginCB.h</a><li>CBLoginRcv_RequestMOTD
|
||||
: <a class="el" href="GSLoginCB_8h.html#a8">GSLoginCB.h</a><li>CBLoginRcv_SystemPage
|
||||
: <a class="el" href="GSLoginCB_8h.html#a4">GSLoginCB.h</a><li>CBPSRcv_Disconnection
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a1">GSPersistentCB.h</a><li>CBPSRcv_GetDataReply
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a3">GSPersistentCB.h</a><li>CBPSRcv_LoginResult
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a0">GSPersistentCB.h</a><li>CBPSRcv_SetDataReply
|
||||
: <a class="el" href="GSPersistentCB_8h.html#a2">GSPersistentCB.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,38 @@
|
||||
<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>Login Service</h1>Functions used to connect to the <em><b>login service</b></em>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group1__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Messages sent to the game service. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group1__2.html">Callback registration</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register the callbacks function names. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__LoginCB.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The login service function callbacks. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send login-related message to the server and to register the callbacks functions related to login messages <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>
|
||||
@@ -0,0 +1,672 @@
|
||||
<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>
|
||||
@@ -0,0 +1,432 @@
|
||||
<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>Callback registration<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group1.html">Login Service</a>]</small>
|
||||
</h1>Register the callbacks function names.
|
||||
<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__2.html#a0">LoginFix_PlayerInfo</a> (<a class="el" href="GSLoginCB_8h.html#a0">CBLoginRcv_PlayerInfo</a> fPlayerInfo)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a1">LoginFix_JoinWaitModuleResult</a> (<a class="el" href="GSLoginCB_8h.html#a1">CBLoginRcv_JoinWaitModuleResult</a> fJoinWaitModuleResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a2">LoginFix_LoginRouterResult</a> (<a class="el" href="GSLoginCB_8h.html#a2">CBLoginRcv_LoginRouterResult</a> fLoginRouterResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a3">LoginFix_LoginWaitModuleResult</a> (<a class="el" href="GSLoginCB_8h.html#a3">CBLoginRcv_LoginWaitModuleResult</a> fLoginWaitModuleResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a4">LoginFix_SystemPage</a> (<a class="el" href="GSLoginCB_8h.html#a4">CBLoginRcv_SystemPage</a> fSystemPage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a5">LoginFix_LoginDisconnection</a> (<a class="el" href="GSLoginCB_8h.html#a5">CBLoginRcv_LoginDisconnection</a> fLoginDisconnection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a6">LoginFix_LoginAccountCreationResult</a> (<a class="el" href="GSLoginCB_8h.html#a6">CBLoginRcv_AccountCreationResult</a> fLoginCreateAccount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a7">LoginFix_ModifyUserResult</a> (<a class="el" href="GSLoginCB_8h.html#a7">CBLoginRcv_ModifyUserResult</a> fLoginModifyUser)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__2.html#a8">LoginFix_RequestMOTD</a> (<a class="el" href="GSLoginCB_8h.html#a8">CBLoginRcv_RequestMOTD</a> fRequestMOTD)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a8"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
Theses functions are used to set the function name for the callbacks of the <b><em>login service</em></b>. <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::LoginFix_JoinWaitModuleResult" ></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 LoginFix_JoinWaitModuleResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a1">CBLoginRcv_JoinWaitModuleResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fJoinWaitModuleResult</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 set the function name for the callback.</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>fJoinWaitModuleResult</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a1">CBLoginRcv_JoinWaitModuleResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LoginFix_LoginAccountCreationResult" ></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 LoginFix_LoginAccountCreationResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a6">CBLoginRcv_AccountCreationResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginCreateAccount</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 set the function name for the callback</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>fLoginCreateAccount</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a6">CBLoginRcv_AccountCreationResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LoginFix_LoginDisconnection" ></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 LoginFix_LoginDisconnection </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a5">CBLoginRcv_LoginDisconnection</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginDisconnection</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 set the function name for the callback</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>fLoginDisconnection</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a5">CBLoginRcv_LoginDisconnection</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LoginFix_LoginRouterResult" ></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 LoginFix_LoginRouterResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a2">CBLoginRcv_LoginRouterResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginRouterResult</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 set the function name for the callback.</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>fLoginRouterResult</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LoginFix_LoginWaitModuleResult" ></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 LoginFix_LoginWaitModuleResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a3">CBLoginRcv_LoginWaitModuleResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginWaitModuleResult</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 set the function name for the callback.</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>fLoginWaitModuleResult</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LoginFix_ModifyUserResult" ></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 LoginFix_ModifyUserResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a7">CBLoginRcv_ModifyUserResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginModifyUser</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 set the function name for the callback</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>fLoginModifyUser</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a7">CBLoginRcv_ModifyUserResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::LoginFix_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 LoginFix_PlayerInfo </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a0">CBLoginRcv_PlayerInfo</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPlayerInfo</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 set the function name for the callback.</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>fPlayerInfo</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a0">CBLoginRcv_PlayerInfo</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::LoginFix_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 LoginFix_RequestMOTD </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a8">CBLoginRcv_RequestMOTD</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fRequestMOTD</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 set the function name for the callback</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>fRequestMOTD</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a8">CBLoginRcv_RequestMOTD</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LoginFix_SystemPage" ></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 LoginFix_SystemPage </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLoginCB_8h.html#a4">CBLoginRcv_SystemPage</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fSystemPage</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 to set the function name for the callback.</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>fSystemPage</em> </td><td>Name of a function of type <a class="el" href="group__group__LoginCB.html#a4">CBLoginRcv_SystemPage</a> </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>
|
||||
@@ -0,0 +1,38 @@
|
||||
<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>Friends Service</h1>Functions used to connect and use the <b><em>friend service</em></b>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group2__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Messages sent to the game service. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group2__2.html">Callback registration</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register the callbacks function names. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__FriendCB.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The friends service function callbacks. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These functions are used to send friend-related messages to the server and to register the callbacks <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>
|
||||
@@ -0,0 +1,886 @@
|
||||
<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__group2.html">Friends 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__group2__1.html#a0">Friends_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 friend 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__group2__1.html#a1">FriendsSend_Connect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is deprecated. </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__group2__1.html#a2">FriendsSend_Disconnect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the friends service. </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__group2__1.html#a3">FriendsSend_Login</a> (GSint lStatus=0, GSint lMood=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Log into the friends service. </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__group2__1.html#a4">FriendsSend_AddFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new friend. </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__group2__1.html#a5">FriendsSend_DelFriend</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a friend from friend list. </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__group2__1.html#a6">FriendsSend_FriendList</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all friends in friend list. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds someone to the player's ignore-list. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer</a> (const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes someone to the player's ignore-list. </em> <a href="#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ignore-list of the player. </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__group2__1.html#a10">FriendsSend_PagePlayer</a> (const GSchar *szUsername, const GSchar *szMessage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a page to a friend. </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__group2__1.html#a11">FriendsSend_PeerPlayer</a> (const GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send data to a friend. </em> <a href="#a11"></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__group2__1.html#a12">FriendsSend_StatusChange</a> (GSint iStatus, GSint iMood)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the player status. </em> <a href="#a12"></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__group2__1.html#a13">FriendsSend_ChangeFriend</a> (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change friend properties. </em> <a href="#a13"></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__group2__1.html#a14">FriendsSend_SearchPlayer</a> (const GSchar *szUsername, const GSchar *szSurName, const GSchar *szFirstName, const GSchar *szCountry, const GSchar *szEmail, GSint iSex, const GSchar *szGame)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for a player. </em> <a href="#a14"></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__group2__1.html#a15">FriendsSend_GetPlayerScores</a> (const GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get player score. </em> <a href="#a15"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send friend-related messages to the server <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::Friends_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 Friends_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 friend 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 problem with the communication of messages 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="a4" doxytag="GSClientLibrary.h::FriendsSend_AddFriend" ></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 FriendsSend_AddFriend </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>szGroup</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iOptions</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 add a new friend to the player's friend list. These friends are stored on the server so you don't have to be stored locally.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for the new friend<br>
|
||||
</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 added new friend </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure when added new friend</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 will be added </td></tr>
|
||||
<tr><td valign=top><em>szGroup</em> </td><td>The group to which the player will be added. This is just a string so that is saved for the friend. You can have any number of groups. </td></tr>
|
||||
<tr><td valign=top><em>iOptions</em> </td><td>Friend options. See define.h </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a13" doxytag="GSClientLibrary.h::FriendsSend_ChangeFriend" ></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 FriendsSend_ChangeFriend </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>szGroup</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iOptions</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 change friend properties like options or the group he is in.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> will have the updated info.</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>username of the friend </td></tr>
|
||||
<tr><td valign=top><em>szGroup</em> </td><td>New group of the player </td></tr>
|
||||
<tr><td valign=top><em>iOptions</em> </td><td>Friend options </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::FriendsSend_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 FriendsSend_Connect </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>You don't need to call this function anymore to connect to the friends service. See <a class="el" href="group__group2__1.html#a3">FriendsSend_Login()</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 connected to the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to connect to the friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::FriendsSend_DelFriend" ></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 FriendsSend_DelFriend </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 remove a friend from the player's friend list</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</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 removed friend </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure when removing friend</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>username of the friend we want to remove </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::FriendsSend_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 FriendsSend_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>This function is used to disconnect from the friends service</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 disconnect from the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to disconnect from the friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::FriendsSend_FriendList" ></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 FriendsSend_FriendList </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 get the list of friends that are in our friend list. This normally doesn't have to be called because the server pushes the <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> callbacks to the client. If client for some reason forgets the list of friends they have this function can called to force an <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for all their friends.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for every friend</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>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a15" doxytag="GSClientLibrary.h::FriendsSend_GetPlayerScores" ></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 FriendsSend_GetPlayerScores </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>DEPRECATED: This function has been replaced by the Ladder Query Service</dd></dl>
|
||||
<dl compact><dt><b>Callback:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</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>Username of the player we want to get the score from. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::FriendsSend_IgnorePlayer" ></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"> GSRESULT FriendsSend_IgnorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szPlayer</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 adds a ubi.com username to the player's ignore-list. When someone is on a player's ignore-list, it cannot send pages or peer-messages to the player ignoring it. The ignore-list is stored remotely on the servers.</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player to ignore (case-insensitive)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADARG</em> </td><td>The szPlayer argument is NULL or empty </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::FriendsSend_ListIgnoredPlayers" ></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"> GSRESULT FriendsSend_ListIgnoredPlayers </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 gets the remotely stored ignore-list of a player</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers<br></a> <a class="el" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::FriendsSend_Login" ></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 FriendsSend_Login </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSint </td>
|
||||
<td class="mdname" nowrap> <em>lStatus</em> = 0, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>lMood</em> = 0</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 log into the friends service. See define.h for the list of statuses.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> for all your friends<br>
|
||||
</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 logged into the friends service </td></tr>
|
||||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure to log into the friends service</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>lStatus</em> </td><td>Status of the player (default at 0) </td></tr>
|
||||
<tr><td valign=top><em>lMood</em> </td><td>Mood of the player (default at 0) </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::FriendsSend_PagePlayer" ></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 FriendsSend_PagePlayer </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>szMessage</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 send a page to a player. If the player isn't online the message will be saved and sent to them the next time they login to the friends service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a> telling you if the message was sent. <a class="el" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a> is sent to the other player</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 recipient player </td></tr>
|
||||
<tr><td valign=top><em>szMessage</em> </td><td>The actual message </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::FriendsSend_PeerPlayer" ></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 FriendsSend_PeerPlayer </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>GSvoid * </td>
|
||||
<td class="mdname" nowrap> <em>p_Buffer</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiLength</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 send binary data to a friend. You can only send peer messages to players that are have the same client version as you. </dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer<br></a> <a class="el" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a> is sent to the other player<br>
|
||||
</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>Username of the recipient player of the data. </td></tr>
|
||||
<tr><td valign=top><em>p_Buffer</em> </td><td>Data buffer. </td></tr>
|
||||
<tr><td valign=top><em>uiLength</em> </td><td>Lenght of the buffer. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a14" doxytag="GSClientLibrary.h::FriendsSend_SearchPlayer" ></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 FriendsSend_SearchPlayer </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>szSurName</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>szCountry</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>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iSex</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</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 search a player in the database. Any of the arguments can be left blank, the server will return a list of matching player that as the search pattern.</dd></dl>
|
||||
<dl compact><dt><b>Callback:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</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>username of the player </td></tr>
|
||||
<tr><td valign=top><em>szSurName</em> </td><td>Player last name </td></tr>
|
||||
<tr><td valign=top><em>szFirstName</em> </td><td>Player first name </td></tr>
|
||||
<tr><td valign=top><em>szCountry</em> </td><td>Player's country </td></tr>
|
||||
<tr><td valign=top><em>szEmail</em> </td><td>Player's email </td></tr>
|
||||
<tr><td valign=top><em>iSex</em> </td><td>Player's gender </td></tr>
|
||||
<tr><td valign=top><em>szGame</em> </td><td>Player's favorite game </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a12" doxytag="GSClientLibrary.h::FriendsSend_StatusChange" ></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 FriendsSend_StatusChange </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSint </td>
|
||||
<td class="mdname" nowrap> <em>iStatus</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iMood</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 set a new status and mood for the current player.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange<br></a> <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> is sent to anyone who has the player as friend.</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>iStatus</em> </td><td>New status of the player </td></tr>
|
||||
<tr><td valign=top><em>iMood</em> </td><td>New mood of the player </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::FriendsSend_UnignorePlayer" ></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"> GSRESULT FriendsSend_UnignorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szPlayer</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 removes a ubi.com username to the player's ignore-list.</dd></dl>
|
||||
To use this function successfully, you needs to be logged in to ubi.com and to the Friends service.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer<br></a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player to remove from the ignore-list (case-insensitive)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The library needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADMODE</em> </td><td>The user is not logged in to the Friends service </td></tr>
|
||||
<tr><td valign=top><em>GSE_BADARG</em> </td><td>The szPlayer argument is NULL or empty </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>
|
||||
@@ -0,0 +1,747 @@
|
||||
<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>Callback registration<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group2.html">Friends Service</a>]</small>
|
||||
</h1>Register the callbacks function names.
|
||||
<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__group2__2.html#a0">FriendsFix_LoginResult</a> (<a class="el" href="GSFriendsCB_8h.html#a0">CBFriendsRcv_LoginResult</a> fLoginResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a1">FriendsFix_AddFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a1">CBFriendsRcv_AddFriend</a> fAddFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a2">FriendsFix_DelFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a2">CBFriendsRcv_DelFriend</a> fDelFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a2"></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__group2__2.html#a3">FriendsFix_IgnorePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a3">CBFriendsRcv_IgnorePlayer</a> fIgnorePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a3"></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__group2__2.html#a4">FriendsFix_UnignorePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a4">CBFriendsRcv_UnignorePlayer</a> fUnignorePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a4"></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__group2__2.html#a5">FriendsFix_ListIgnoredPlayers</a> (<a class="el" href="GSFriendsCB_8h.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> fListIgnoredPlayers)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a5"></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__group2__2.html#a6">FriendsFix_IgnoredPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a6">CBFriendsRcv_IgnoredPlayer</a> fIgnoredPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a7">FriendsFix_Page</a> (<a class="el" href="GSFriendsCB_8h.html#a7">CBFriendsRcv_Page</a> fPage)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a8">FriendsFix_PagePlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a8">CBFriendsRcv_PagePlayer</a> fPagePlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a9">FriendsFix_PeerMsg</a> (<a class="el" href="GSFriendsCB_8h.html#a9">CBFriendsRcv_PeerMsg</a> fPeerMsg)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a10">FriendsFix_PeerPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a10">CBFriendsRcv_PeerPlayer</a> fPeerPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group2__2.html#a11">FriendsFix_StatusChange</a> (<a class="el" href="GSFriendsCB_8h.html#a12">CBFriendsRcv_StatusChange</a> fStatusChange)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a11"></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__group2__2.html#a12">FriendsFix_ChangeFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a11">CBFriendsRcv_ChangeFriend</a> fChangeFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a12"></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__group2__2.html#a13">FriendsFix_UpdateFriend</a> (<a class="el" href="GSFriendsCB_8h.html#a13">CBFriendsRcv_UpdateFriend</a> fUpdateFriend)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a13"></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__group2__2.html#a14">FriendsFix_SearchPlayer</a> (<a class="el" href="GSFriendsCB_8h.html#a14">CBFriendsRcv_SearchPlayer</a> fSearchPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a14"></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__group2__2.html#a15">FriendsFix_ScoreCard</a> (<a class="el" href="GSFriendsCB_8h.html#a15">CBFriendsRcv_ScoreCard</a> fScoreCard)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a15"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
Theses functions are used to set the function name for the callbacks of the <b><em>friends service</em></b>. <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::FriendsFix_AddFriend" ></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 FriendsFix_AddFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a1">CBFriendsRcv_AddFriend</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fAddFriend</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 set the function name for the callback</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>fAddFriend</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a12" doxytag="GSClientLibrary.h::FriendsFix_ChangeFriend" ></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 FriendsFix_ChangeFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a11">CBFriendsRcv_ChangeFriend</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fChangeFriend</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 set the function name for the callback</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>fChangeFriend</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a11">CBFriendsRcv_ChangeFriend</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::FriendsFix_DelFriend" ></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 FriendsFix_DelFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a2">CBFriendsRcv_DelFriend</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fDelFriend</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 set the function name for the callback</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>fDelFriend</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::FriendsFix_IgnoredPlayer" ></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 FriendsFix_IgnoredPlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a6">CBFriendsRcv_IgnoredPlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fIgnoredPlayer</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 set the function name for the callback</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>fIgnoredPlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::FriendsFix_IgnorePlayer" ></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 FriendsFix_IgnorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a3">CBFriendsRcv_IgnorePlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fIgnorePlayer</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 set the function name for the callback</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>fIgnorePlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::FriendsFix_ListIgnoredPlayers" ></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 FriendsFix_ListIgnoredPlayers </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fListIgnoredPlayers</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 set the function name for the callback</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>fListIgnoredPlayers</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::FriendsFix_LoginResult" ></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 FriendsFix_LoginResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a0">CBFriendsRcv_LoginResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fLoginResult</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 set the function name for the callback</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>fLoginResult</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::FriendsFix_Page" ></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 FriendsFix_Page </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a7">CBFriendsRcv_Page</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPage</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 set the function name for the callback</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>fPage</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::FriendsFix_PagePlayer" ></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 FriendsFix_PagePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a8">CBFriendsRcv_PagePlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPagePlayer</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 set the function name for the callback</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>fPagePlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::FriendsFix_PeerMsg" ></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 FriendsFix_PeerMsg </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a9">CBFriendsRcv_PeerMsg</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPeerMsg</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 set the function name for the callback</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>fPeerMsg</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::FriendsFix_PeerPlayer" ></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 FriendsFix_PeerPlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a10">CBFriendsRcv_PeerPlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPeerPlayer</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 set the function name for the callback</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>fPeerPlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a15" doxytag="GSClientLibrary.h::FriendsFix_ScoreCard" ></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 FriendsFix_ScoreCard </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a15">CBFriendsRcv_ScoreCard</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fScoreCard</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 set the function name for the callback</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>fScoreCard</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a14" doxytag="GSClientLibrary.h::FriendsFix_SearchPlayer" ></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 FriendsFix_SearchPlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a14">CBFriendsRcv_SearchPlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fSearchPlayer</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 set the function name for the callback</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>fSearchPlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::FriendsFix_StatusChange" ></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 FriendsFix_StatusChange </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a12">CBFriendsRcv_StatusChange</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fStatusChange</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 set the function name for the callback</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>fStatusChange</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::FriendsFix_UnignorePlayer" ></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 FriendsFix_UnignorePlayer </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a4">CBFriendsRcv_UnignorePlayer</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fUnignorePlayer</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 set the function name for the callback</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>fUnignorePlayer</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a13" doxytag="GSClientLibrary.h::FriendsFix_UpdateFriend" ></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 FriendsFix_UpdateFriend </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSFriendsCB_8h.html#a13">CBFriendsRcv_UpdateFriend</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fUpdateFriend</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 set the function name for the callback</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>fUpdateFriend</em> </td><td>Name of a function of type <a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> </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>
|
||||
@@ -0,0 +1,38 @@
|
||||
<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>Lobby Service</h1>Functions used to connect to the <b><em>lobby service</em></b>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group4__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Messages sent to the lobby server. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group4__2.html">Callback registration</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register the callbacks function names. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__LobbyCB.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The lobby service function callbacks. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send lobby related message to the server and to register the callbacks <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>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,38 @@
|
||||
<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>Persistent Storage Service</h1>Functions used to connect to the <b><em>persistent storage service</em></b>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group5__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Messages sent to the persistent storage service. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group5__2.html">Callback registration</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">persistent storage service callbacks <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__PSCB.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The persistent storage service function callbacks. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send persistent storage related message to the server and to register the callbacks functions related to this service <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>
|
||||
@@ -0,0 +1,424 @@
|
||||
<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__group5.html">Persistent Storage Service</a>]</small>
|
||||
</h1>Messages sent to the persistent storage 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__group5__1.html#a0">PSSend_Login</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Login to the persistent storage 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__group5__1.html#a1">PSSend_Disconnect</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the persistent storage service. </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__group5__1.html#a2">PS_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 persistent data storage service. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a3">PSSend_GetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the private data related to a player. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a4">PSSend_SetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the private data related to a player. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a5">PSSend_GetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSchar *szUsername=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the public data related to a player. </em> <a href="#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a6">PSSend_SetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the public data related to a player. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used to send to messages to the persistent storage server <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::PS_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 PS_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 persistent data storage service service. This function should be called regularly to ensure that the application will run smoothly with the service.</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::PSSend_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 PSSend_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 persistent storage service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</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>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::PSSend_GetPrivateData" ></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"> GSuint PSSend_GetPrivateData </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iRecordID</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>Get the private data related to a player using the persistent data storage service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
||||
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
||||
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::PSSend_GetPublicData" ></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"> GSuint PSSend_GetPublicData </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szUsername</em> = 0</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>Get the public data related to a player using the persistent data storage service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
||||
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
||||
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the player related with the data (Default to the current username if the argument is not passed) </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::PSSend_Login" ></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 PSSend_Login </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>Login to the persistent storage service. Will return false if unable to connect true on success</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</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>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::PSSend_SetPrivateData" ></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"> GSuint PSSend_SetPrivateData </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSvoid * </td>
|
||||
<td class="mdname" nowrap> <em>vpData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iSize</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>Set the private data related to a player using the persistent data storage service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szGame</em> </td><td>The name of the game </td></tr>
|
||||
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
||||
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
||||
<tr><td valign=top><em>vpData</em> </td><td>The actual data buffer </td></tr>
|
||||
<tr><td valign=top><em>iSize</em> </td><td>Size of the data buffer </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::PSSend_SetPublicData" ></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"> GSuint PSSend_SetPublicData </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSvoid * </td>
|
||||
<td class="mdname" nowrap> <em>vpData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint </td>
|
||||
<td class="mdname" nowrap> <em>iSize</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>Set the public data related to a player using the persistent data storage service.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
||||
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
||||
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
||||
<tr><td valign=top><em>vpData</em> </td><td>The actual data buffer </td></tr>
|
||||
<tr><td valign=top><em>iSize</em> </td><td>Size of the data buffer </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>
|
||||
@@ -0,0 +1,207 @@
|
||||
<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>Callback registration<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group5.html">Persistent Storage Service</a>]</small>
|
||||
</h1>persistent storage service callbacks
|
||||
<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__group5__2.html#a0">PSFix_LoginResult</a> (<a class="el" href="GSPersistentCB_8h.html#a0">CBPSRcv_LoginResult</a> fPSLoginResult)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group5__2.html#a1">PSFix_Disconnection</a> (<a class="el" href="GSPersistentCB_8h.html#a1">CBPSRcv_Disconnection</a> fPSDisconnection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group5__2.html#a2">PSFix_SetDataReply</a> (<a class="el" href="GSPersistentCB_8h.html#a2">CBPSRcv_SetDataReply</a> fSetDataReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </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__group5__2.html#a3">PSFix_GetDataReply</a> (<a class="el" href="GSPersistentCB_8h.html#a3">CBPSRcv_GetDataReply</a> fGetDataReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used register persistent storage service callbacks <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::PSFix_Disconnection" ></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 PSFix_Disconnection </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSPersistentCB_8h.html#a1">CBPSRcv_Disconnection</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPSDisconnection</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 register the disconnection callback for the persistent storage service</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>fPSDisconnection</em> </td><td>Name of a function of type <a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::PSFix_GetDataReply" ></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 PSFix_GetDataReply </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSPersistentCB_8h.html#a3">CBPSRcv_GetDataReply</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fGetDataReply</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 register the GetDataReply callback for the persistent storage service</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>fGetDataReply</em> </td><td>Name of a function of type <a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::PSFix_LoginResult" ></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 PSFix_LoginResult </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSPersistentCB_8h.html#a0">CBPSRcv_LoginResult</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fPSLoginResult</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 register the LoginResult callback for the persistent storage service</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>fPSLoginResult</em> </td><td>Name of a function of type <a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a> </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::PSFix_SetDataReply" ></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 PSFix_SetDataReply </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSPersistentCB_8h.html#a2">CBPSRcv_SetDataReply</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fSetDataReply</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 register the SetDataReply callback for the persistent storage service</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>fSetDataReply</em> </td><td>Name of a function of type <a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a> </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>
|
||||
@@ -0,0 +1,43 @@
|
||||
<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>Ladder Query Service</h1>Functions used to use the <b><em>ladder query service</em></b>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group6__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Messages sent to the <b><em>ladder query service</em></b>. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group6__2.html">Results fetching</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the entries requested when a request completed successfully. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group6__3.html">Callback registration</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">ladder query service callbacks <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__LadderQuery.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The ladder query service function callbacks. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
Theses functions are used to query the ubi.com data providers to get ranking informations on players. <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>
|
||||
@@ -0,0 +1,655 @@
|
||||
<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__group6.html">Ladder Query Service</a>]</small>
|
||||
</h1>Messages sent to the <b><em>ladder query service</em></b>.
|
||||
<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__group6__1.html#a0">LadderQuery_Initialize</a> (GSchar *szLocale)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the ladder query 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__group6__1.html#a1">LadderQuery_Uninitialize</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uninitialization function for the ladder query service. </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__group6__1.html#a2">LadderQuery_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status related to the ladder query service. </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__group6__1.html#a3">LadderQuery_CreateRequest</a> (GSchar *szGameName, GSuint uiEvent=0, GSuint uiMode=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a basic ladder query request. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__1.html#a4">LadderQuery_SendRequest</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a request over the network. </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__group6__1.html#a5">LadderQuery_RequestPivotUser</a> (const GSchar *pszEntry, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (username). </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__group6__1.html#a6">LadderQuery_RequestPivotRow</a> (GSuint uiRowNumber, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries around a pivot (row number). </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__group6__1.html#a7">LadderQuery_RequestSet</a> (const GSchar *pszEntries[], GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting a pre-defined set of entries. </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__group6__1.html#a8">LadderQuery_RequestOrderedList</a> (GSuint uiFirstEntry, GSuint uiNumberOfEntries)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requesting an ordered list of entries from a starting index (row number). </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__group6__1.html#a9">LadderQuery_AddSortConstraint</a> (const GSchar *pszField, GSbool bSortDirection)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>sort</b> constraint to a created request. </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__group6__1.html#a10">LadderQuery_AddFilterConstraint</a> (const <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> *pLadderFilter[], GSuint uiListOfFilters)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>filter</b> constraint to a created request. </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__group6__1.html#a11">LadderQuery_AddDisplayConstraint</a> (const GSchar *pszFields[], GSuint uiNumberOfFields)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <b>display</b> constraint to a created request. </em> <a href="#a11"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These functions are used to send request to the ubi.com data provider and retrieve results when a reply is given by the server. <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::LadderQuery_AddDisplayConstraint" ></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_AddDisplayConstraint </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszFields</em>[], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumberOfFields</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 set a display constraint to a request that has been created. Display constraint will make the results contain only the supplied list of fields.</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>pszFields</em> </td><td>A pointer to an array of string values (fields). </td></tr>
|
||||
<tr><td valign=top><em>uiNumberOfFields</em> </td><td>The size of the array of string values. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::LadderQuery_AddFilterConstraint" ></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_AddFilterConstraint </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> * </td>
|
||||
<td class="mdname" nowrap> <em>pLadderFilter</em>[], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiListOfFilters</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 set a filter constraint to a request that has been created. Filters are defined using the <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a> structure.</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>pLadderFilter</em> </td><td>A pointer to an array of ladder filter. </td></tr>
|
||||
<tr><td valign=top><em>uiListOfFilters</em> </td><td>The size of the array of ladder filter. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::LadderQuery_AddSortConstraint" ></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_AddSortConstraint </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszField</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSbool </td>
|
||||
<td class="mdname" nowrap> <em>bSortDirection</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 set a sort constraint to a request that has been created.</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>pszField</em> </td><td>The field name to sort by. </td></tr>
|
||||
<tr><td valign=top><em>bSortDirection</em> </td><td>The sort direction where GS_TRUE = natural order and GS_FALSE = unnatural order. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LadderQuery_CreateRequest" ></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_CreateRequest </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>szGameName</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiEvent</em> = 0, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiMode</em> = 0</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 creates a basic ladder query request (ordered list, with no constraint) that can be sent over the network to the ubi.com data provider. The <a class="el" href="group__group6__1.html#a3">LadderQuery_CreateRequest()</a> function should be called each time you want to make a request. Once the request is created, you can tell which type of request you want, and optionally add one or more constraint. If you call this function again before sending the request created previously, the type and constraint of the previous request are overwritten by the default ones.</dd></dl>
|
||||
<b>NOTE</b>: <em>This function will return GS_FALSE if you have not completed the login sequence on the gs-router server.</em><p>
|
||||
<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>szGameName</em> </td><td>The game name associated with the requested ladder data. </td></tr>
|
||||
<tr><td valign=top><em>uiEvent</em> </td><td>The event id associated with the ladder data. </td></tr>
|
||||
<tr><td valign=top><em>uiMode</em> </td><td>The game mode. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LadderQuery_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 LadderQuery_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 ladder query service service. This function should be called regularly to ensure that the service will run smoothly and properly.</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="a0" doxytag="GSClientLibrary.h::LadderQuery_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"> GSbool LadderQuery_Initialize </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szLocale</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 takes a 2 character string argument that represent the locale in which the string results will be returned from the server.</dd></dl>
|
||||
The initialisation of the ladder query service can be done after the client library initialization (i.g. <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary_Initialize()</a>)<p>
|
||||
<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>szLocale</em> </td><td>The locale in which the string results will be returned from the server. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::LadderQuery_RequestOrderedList" ></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_RequestOrderedList </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiFirstEntry</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumberOfEntries</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 set the request mode to retrieve an ordered list of entries from a starting zero-based index representing a row number.</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>uiFirstEntry</em> </td><td>Zero-based index of the first entry to get. </td></tr>
|
||||
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries in the array of values. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LadderQuery_RequestPivotRow" ></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_RequestPivotRow </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRowNumber</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumberOfEntries</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 set the request mode to retrieve an ordered list of entries around a pivot where the pivot is a row number in the ladder.</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>uiRowNumber</em> </td><td>The row number used as a pivot. </td></tr>
|
||||
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries to retrieve. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LadderQuery_RequestPivotUser" ></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_RequestPivotUser </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszEntry</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumberOfEntries</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 set the request mode to retrieve an ordered list of entries around a pivot where the pivot is a user name entry.</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>pszEntry</em> </td><td>Pointer to a character string representing the username to use as a pivot. </td></tr>
|
||||
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries to retrieve. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LadderQuery_RequestSet" ></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_RequestSet </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszEntries</em>[], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumberOfEntries</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 set the request mode to retrieve a pre-defined set of entries supplied by the caller.</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>pszEntries</em> </td><td>Pointer on an array of string values. Each string values should be a username. </td></tr>
|
||||
<tr><td valign=top><em>uiNumberOfEntries</em> </td><td>Total number of entries in the array of values. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LadderQuery_SendRequest" ></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"> GSuint LadderQuery_SendRequest </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 send a request over the network to the ubi.com servers. This function will return the id of the sent request and in case of error it will return 0. The id of the request will be used once we get the results so you have to keep it in memory.</dd></dl>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a></dd></dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>The id of the request that has been sent.</dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>0</em> </td><td>Internal error </td></tr>
|
||||
<tr><td valign=top><em>else</em> </td><td>The id of the request that has been sent. </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::LadderQuery_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"> GSbool LadderQuery_Uninitialize </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 uninitialize the ladder query service and free allocated memory.</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>
|
||||
</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>
|
||||
@@ -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 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>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 </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a0">LadderQuery_GetResultSearchCount</a> (GSuint uiRequestID, GSuint &uiCount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a1">LadderQuery_GetResultEntryCount</a> (GSuint uiRequestID, GSuint &uiCount)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </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"> </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 </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"> </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 </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"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="group__group6__2.html#a5">LadderQuery_GetCurrentEntryField</a> (GSuint uiRequestID, const GSchar *pszField, GSint &iValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </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"> </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 </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"> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszField</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSint & </td>
|
||||
<td class="mdname" nowrap> <em>iValue</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>pszField</em> </td><td>Pointer to a character string representing the field name. </td></tr>
|
||||
<tr><td valign=top><em>iValue</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszField</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszValue</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>pszField</em> </td><td>Pointer to a character string representing the field name. </td></tr>
|
||||
<tr><td valign=top><em>pszValue</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint & </td>
|
||||
<td class="mdname" nowrap> <em>uiCount</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>uiCount</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszField</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSchar * </td>
|
||||
<td class="mdname" nowrap> <em>pszCaption</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>pszField</em> </td><td>Pointer to a character string representing the field name to identify. </td></tr>
|
||||
<tr><td valign=top><em>pszCaption</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint & </td>
|
||||
<td class="mdname" nowrap> <em>uiCount</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>uiCount</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>uiRequestID</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 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> </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>uiRequestID</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>uiRequestID</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 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> </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>uiRequestID</em> </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">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiStartEntry</em> = 0</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 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> </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>uiRequestID</em> </td><td>The request identifier supplied in the callback. </td></tr>
|
||||
<tr><td valign=top><em>uiStartEntry</em> </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 - ©UbiSoft Entertainment 2002 </i><br>
|
||||
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,72 @@
|
||||
<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>Callback registration<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group6.html">Ladder Query Service</a>]</small>
|
||||
</h1>ladder query service callbacks
|
||||
<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__group6__3.html#a0">LadderQueryFix_RequestReply</a> (<a class="el" href="GSLadderQueryCB_8h.html#a0">CBLadderQueryRcv_RequestReply</a> fQueryReply)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the function name for the callback. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These function are used register ladder query service callbacks <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::LadderQueryFix_RequestReply" ></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 LadderQueryFix_RequestReply </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="GSLadderQueryCB_8h.html#a0">CBLadderQueryRcv_RequestReply</a> </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>fQueryReply</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 register the LadderQuery RequestReply callback for the ladder query service</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>fQueryReply</em> </td><td>Name of a function of type <a class="el" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a> </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>
|
||||
@@ -0,0 +1,38 @@
|
||||
<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>Remote Algorithm Execution Service</h1>Information about the <b><em>remote algorithm execution service</em></b>.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group7__1.html">Functions</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions of the service. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group7__2.html">Type Definition</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Definitions of the service's data type. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="group__group__RAECB.html">Callbacks</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">List of the callbacks available in the remote algorithm execution service. <br><br></td></tr>
|
||||
|
||||
<p>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
These are the functions and structures exported by the service. <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>
|
||||
@@ -0,0 +1,256 @@
|
||||
<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__group7.html">Remote Algorithm Execution Service</a>]</small>
|
||||
</h1>Functions of the 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>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise</a> (const GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises the resources required by the service. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a1">RemoteAlgorithm_Uninitialise</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the resources acquired by the service. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a2">RemoteAlgorithm_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxOperationalDelay=800)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs the service. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSRESULT </td><td class="memItemRight" valign=bottom><a class="el" href="group__group7__1.html#a3">RemoteAlgorithm_Execute</a> (GSuint uiAlgoId, const <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a> *pInput, GSuint uiNumInput, const <a class="el" href="GSRemoteAlgorithmCB_8h.html#a0">RemoteAlgorithm_OutputCB</a> fOutput, const GSvoid *pData, GSuint &uiRequestId)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requests the execution of an algorithm. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
There functions are that need to be used in order to access the service <hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::RemoteAlgorithm_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"> GSRESULT RemoteAlgorithm_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>uiMaxOperationalDelay</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>This function keeps the service alive by process the outgoing request and the incoming replies.</dd></dl>
|
||||
It is important that this function be called regularly to insure proper working of the service.<p>
|
||||
This function can only be called after having called <a class="el" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise()</a>.<p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>uiMaxPostingDelay</em> </td><td>Maximum time (in millisec) to spend reading messages </td></tr>
|
||||
<tr><td valign=top><em>uiMaxOperationalDelay</em> </td><td>Maximum time (in millisec) to spend processing read messages (the others will be put in a queue)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The service needs to be initialised </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::RemoteAlgorithm_Execute" ></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"> GSRESULT RemoteAlgorithm_Execute </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiAlgoId</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a> * </td>
|
||||
<td class="mdname" nowrap> <em>pInput</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint </td>
|
||||
<td class="mdname" nowrap> <em>uiNumInput</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const <a class="el" href="GSRemoteAlgorithmCB_8h.html#a0">RemoteAlgorithm_OutputCB</a> </td>
|
||||
<td class="mdname" nowrap> <em>fOutput</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>const GSvoid * </td>
|
||||
<td class="mdname" nowrap> <em>pData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>GSuint & </td>
|
||||
<td class="mdname" nowrap> <em>uiRequestId</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 sends the request to execute the target algorithm. The call to this function is asynchronous. The result of the algorithm will be sent to the callback passed as an argument.</dd></dl>
|
||||
This function can only be called after having called <a class="el" href="group__group7__1.html#a0">RemoteAlgorithm_Initialise()</a>. You also need to be logged in to ubi.com (<a class="el" href="group__group1__1.html#a3">LoginSend_LoginRouter()</a>) for this function to work.<p>
|
||||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__RAECB.html#a0">RemoteAlgorithm_OutputCB<br></a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>uiAlgoId</em> </td><td>The target algorithm identifier </td></tr>
|
||||
<tr><td valign=top><em>pInput</em> </td><td>An array of values to pass as input to the target algorithm </td></tr>
|
||||
<tr><td valign=top><em>uiNumInput</em> </td><td>The number of values in the input array </td></tr>
|
||||
<tr><td valign=top><em>fOutput</em> </td><td>The function to call once the output is ready </td></tr>
|
||||
<tr><td valign=top><em>pData</em> </td><td>Custom data to send back to the callback function </td></tr>
|
||||
<tr><td valign=top><em>uiRequestId</em> </td><td>[OUTPUT] The request identifier when the call succeed</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>There was no error </td></tr>
|
||||
<tr><td valign=top><em>GSE_NOTINITIALIZED</em> </td><td>The service needs to be initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The user is not logged in to ubi.com </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::RemoteAlgorithm_Initialise" ></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"> GSRESULT RemoteAlgorithm_Initialise </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>szGameName</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 initialises the resources that will be required to use the remote algorithm execution service. It takes as input the game identifier character string supplied to the developers by ubi.com.</dd></dl>
|
||||
This function can only be called after having called <a class="el" href="GSClientLibrary_8h.html#a0">GSClientLibrary_Initialize()</a>.<p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szGameName</em> </td><td>The game identifier (i.e. ugly name)</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>The service is ready to be used </td></tr>
|
||||
<tr><td valign=top><em>GSE_ALREADYINITIALIZED</em> </td><td>The library was already initialised </td></tr>
|
||||
<tr><td valign=top><em>GSE_UNEXPECTED</em> </td><td>The client library was not initialised </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::RemoteAlgorithm_Uninitialise" ></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"> GSRESULT RemoteAlgorithm_Uninitialise </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 releases the resources that were acquired during the initialisation.</dd></dl>
|
||||
This function has no effect if RemoveAlgorithm_Initialise() has not been called before.<p>
|
||||
<dl compact><dt><b>Returns:</b></dt><dd>Result code of the operation </dd></dl>
|
||||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>GSS_OK</em> </td><td>No possible error could occur </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>
|
||||
@@ -0,0 +1,24 @@
|
||||
<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>Type Definition<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group7.html">Remote Algorithm Execution Service</a>]</small>
|
||||
</h1>Definitions of the service's data type.
|
||||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
</table>
|
||||
The following definitions are the type of data that are needed to use the service's interface. <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>
|
||||
@@ -0,0 +1,614 @@
|
||||
<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>Callbacks<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group2.html">Friends Service</a>]</small>
|
||||
</h1>The friends service function callbacks.
|
||||
<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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a0">CBFriendsRcv_LoginResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive friends service login result. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a1">CBFriendsRcv_AddFriend</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the friend addition request. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a2">CBFriendsRcv_DelFriend</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the remove friend request. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a3">CBFriendsRcv_IgnorePlayer</a> )(GSRESULT rCode, const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of an ignore player request. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a4">CBFriendsRcv_UnignorePlayer</a> )(GSRESULT rCode, const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of an unignore player request. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a5">CBFriendsRcv_ListIgnoredPlayers</a> )(GSRESULT rCode)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result of a request to get the ignore-list. </em> <a href="#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a6">CBFriendsRcv_IgnoredPlayer</a> )(const GSchar *szPlayer)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of the ignored players. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a7">CBFriendsRcv_Page</a> )(GSchar *szUsername, GSchar *pszMessage, GSchar *szTimeStamp)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a page message. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a8">CBFriendsRcv_PagePlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of send page request. </em> <a href="#a8"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a9">CBFriendsRcv_PeerMsg</a> )(GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a peer message. </em> <a href="#a9"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a10">CBFriendsRcv_PeerPlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the send peer message request. </em> <a href="#a10"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a11">CBFriendsRcv_ChangeFriend</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of change friend request. </em> <a href="#a11"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a12">CBFriendsRcv_StatusChange</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of a change status request. </em> <a href="#a12"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a13">CBFriendsRcv_UpdateFriend</a> )(GSchar *szUsername, GSint iStatus, GSchar *szGroup, GSint iMood, GSint iOptions, GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive information about a friend. </em> <a href="#a13"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a14">CBFriendsRcv_SearchPlayer</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSint iStatus, GSchar *szGameName)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of search player request. </em> <a href="#a14"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__FriendCB.html#a15">CBFriendsRcv_ScoreCard</a> )(GSubyte ubType, GSint iReason, GSchar *szUsername, GSchar *szGame, GSchar *szScore)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive score card information for a player. </em> <a href="#a15"></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="a1" doxytag="GSFriendsCB.h::CBFriendsRcv_AddFriend" ></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="GSFriendsCB_8h.html#a1">CBFriendsRcv_AddFriend</a>)(GSubyte ubType, GSint iReason, GSchar* szUsername)
|
||||
</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 callback will be called when the client receives response from the router after adding a friend to his friend list</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a4">FriendsSend_AddFriend()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORROUTER_DBPROBLEM: There is a problem with the database<br>
|
||||
ERRORFRIENDS_FRIENDNOTEXIST: The username didn't exist.</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szFriend</em> </td><td>The alias of the newly added friend </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a11" doxytag="GSFriendsCB.h::CBFriendsRcv_ChangeFriend" ></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="GSFriendsCB_8h.html#a11">CBFriendsRcv_ChangeFriend</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receives response from the router after sending a change friend request.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a12">FriendsSend_StatusChange()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSFriendsCB.h::CBFriendsRcv_DelFriend" ></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="GSFriendsCB_8h.html#a2">CBFriendsRcv_DelFriend</a>)(GSubyte ubType, GSint iReason, GSchar* szUsername)
|
||||
</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 callback will be called when the client receives response from the router after removing a friend from the friend list.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a5">FriendsSend_DelFriend()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The alias of the newly deleted friend </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a6" doxytag="GSFriendsCB.h::CBFriendsRcv_IgnoredPlayer" ></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="GSFriendsCB_8h.html#a6">CBFriendsRcv_IgnoredPlayer</a>)( const GSchar * szPlayer )
|
||||
</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 callback will be called for each player in a ignore-list following a ignore-list retrieval request. The end of list is notified by the CBFriendsRcv_ListIgnoredPlayers callback.</dd></dl>
|
||||
<br>
|
||||
Related function : <a class="el" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers()</a><p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of a ignored player </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSFriendsCB.h::CBFriendsRcv_IgnorePlayer" ></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="GSFriendsCB_8h.html#a3">CBFriendsRcv_IgnorePlayer</a>)( GSRESULT rCode, const GSchar * szPlayer )
|
||||
</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 callback will be called with the results of a previous ignore player request.</dd></dl>
|
||||
<br>
|
||||
Related function : <a class="el" href="group__group2__1.html#a7">FriendsSend_IgnorePlayer()</a><p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player that was ignored </td></tr>
|
||||
<tr><td valign=top><em>rCode</em> </td><td>Result code of the request. Possible values are: <ul>
|
||||
<li>
|
||||
GSS_OK<br>
|
||||
There was no error </li>
|
||||
<li>
|
||||
GSE_INVALIDUSER<br>
|
||||
The username to ignore is not a valid ubi.com user. </li>
|
||||
<li>
|
||||
GSE_DBFAILURE<br>
|
||||
An error occured on the DB while processing the request. </li>
|
||||
<li>
|
||||
GSE_FAIL<br>
|
||||
An unsuspected error occured most likely due to a bug on ubi.com </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSFriendsCB.h::CBFriendsRcv_ListIgnoredPlayers" ></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="GSFriendsCB_8h.html#a5">CBFriendsRcv_ListIgnoredPlayers</a>)( GSRESULT rCode )
|
||||
</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 callback will be called with the results of a previous ignore-list retrieval request.</dd></dl>
|
||||
<br>
|
||||
Related function : <a class="el" href="group__group2__1.html#a9">FriendsSend_ListIgnoredPlayers()</a><p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>rCode</em> </td><td>Result code of the request. 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 request. </li>
|
||||
<li>
|
||||
GSE_FAIL<br>
|
||||
An unsuspected error occured most likely due to a bug on ubi.com </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSFriendsCB.h::CBFriendsRcv_LoginResult" ></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="GSFriendsCB_8h.html#a0">CBFriendsRcv_LoginResult</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receives response from the router after asking to log into the friend service</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a3">FriendsSend_Login()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSFriendsCB.h::CBFriendsRcv_Page" ></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="GSFriendsCB_8h.html#a7">CBFriendsRcv_Page</a>)(GSchar* szUsername, GSchar* pszMessage, GSchar* szTimeStamp)
|
||||
</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 callback will be called when the client receives a page message from another player</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a10">FriendsSend_PagePlayer()</a></dd></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 sender </td></tr>
|
||||
<tr><td valign=top><em>szMessage</em> </td><td>Message </td></tr>
|
||||
<tr><td valign=top><em>szTimeStamp</em> </td><td>The server timestamp of when the page message was sent </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSFriendsCB.h::CBFriendsRcv_PagePlayer" ></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="GSFriendsCB_8h.html#a8">CBFriendsRcv_PagePlayer</a>)(GSubyte ubType, GSint iReason, GSchar* szUsername)
|
||||
</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 callback will be called when the client receives response from the router after sending a page to another player</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a10">FriendsSend_PagePlayer()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORROUTER_UNKNOWNERROR: The page message was not sent. ERRORFRIENDS_PLAYERSTATUSCOREONLINE: The player can't receive page messages. ERRORFRIENDS_PLAYERIGNORE: The player has ignored the sender</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the recipient </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a9" doxytag="GSFriendsCB.h::CBFriendsRcv_PeerMsg" ></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="GSFriendsCB_8h.html#a9">CBFriendsRcv_PeerMsg</a>)(GSchar* szUsername, GSvoid* p_Buffer, GSuint uiLength)
|
||||
</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 callback will be called when the client receives a peer message from another player</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a11">FriendsSend_PeerPlayer()</a></dd></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>Username of the sender </td></tr>
|
||||
<tr><td valign=top><em>p_Buffer</em> </td><td>Data buffer </td></tr>
|
||||
<tr><td valign=top><em>uiLength</em> </td><td>Length of the buffer </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a10" doxytag="GSFriendsCB.h::CBFriendsRcv_PeerPlayer" ></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="GSFriendsCB_8h.html#a10">CBFriendsRcv_PeerPlayer</a>)(GSubyte ubType, GSint iReason, GSchar* szUsername)
|
||||
</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 callback will be called when the client receives response from the router after sending a peer player message</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a11">FriendsSend_PeerPlayer()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORFRIENDS_PLAYERSTATUSCOREONLINE: The player can't receive peer messages. ERRORROUTER_CLIENTINCOMPATIBLE: The other player doesn't have the same client version as you. ERRORFRIENDS_PLAYERNOTONLINE: The player is not online. ERRORFRIENDS_PLAYERIGNORE: The player has ignored the sender</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>Username of the receiver of the message </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a15" doxytag="GSFriendsCB.h::CBFriendsRcv_ScoreCard" ></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="GSFriendsCB_8h.html#a15">CBFriendsRcv_ScoreCard</a>)(GSubyte ubType, GSint iReason,GSchar* szUsername,GSchar* szGame, GSchar* szScore)
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
<dl compact><dt><b>Description:</b></dt><dd>DEPRECATED: This callback has been replaced by the Ladder Query Service </dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a15">FriendsSend_GetPlayerScores()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>the username of the player </td></tr>
|
||||
<tr><td valign=top><em>szGame</em> </td><td>Game name (ugly) </td></tr>
|
||||
<tr><td valign=top><em>szScore</em> </td><td>Scoree of the player </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a14" doxytag="GSFriendsCB.h::CBFriendsRcv_SearchPlayer" ></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="GSFriendsCB_8h.html#a14">CBFriendsRcv_SearchPlayer</a>)(GSubyte ubType, GSint iReason,GSchar* szUsername, GSint iStatus, GSchar *szGameName)
|
||||
</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 callback will be called when the client receives response from the router after calling for a search of all the player that match a pattern. For each player found, this will be called.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a14">FriendsSend_SearchPlayer()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORFRIENDS_FRIENDNOTEXIST: No more players found.</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>Username of the player that was found </td></tr>
|
||||
<tr><td valign=top><em>iStatus</em> </td><td>Status of the player that was found </td></tr>
|
||||
<tr><td valign=top><em>szGameName</em> </td><td>The GameName when the status is PLAYERINLOBBY, PLAYERINROOMOPEN,PLAYERINROOMCLOSE can be up to GAMELENGTH*4 in size </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a12" doxytag="GSFriendsCB.h::CBFriendsRcv_StatusChange" ></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="GSFriendsCB_8h.html#a12">CBFriendsRcv_StatusChange</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receives response from the router after the player as changed his status</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a12">FriendsSend_StatusChange()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSFriendsCB.h::CBFriendsRcv_UnignorePlayer" ></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="GSFriendsCB_8h.html#a4">CBFriendsRcv_UnignorePlayer</a>)( GSRESULT rCode, const GSchar * szPlayer )
|
||||
</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 callback will be called with the results of a previous unignore player request.</dd></dl>
|
||||
<br>
|
||||
Related function : <a class="el" href="group__group2__1.html#a8">FriendsSend_UnignorePlayer()</a><p>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>szPlayer</em> </td><td>The ubi.com username of the player that was removed from the ignore-list </td></tr>
|
||||
<tr><td valign=top><em>rCode</em> </td><td>Result code of the request. 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 request. </li>
|
||||
<li>
|
||||
GSE_FAIL<br>
|
||||
An unsuspected error occured most likely due to a bug on ubi.com </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a13" doxytag="GSFriendsCB.h::CBFriendsRcv_UpdateFriend" ></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="GSFriendsCB_8h.html#a13">CBFriendsRcv_UpdateFriend</a>)(GSchar* szUsername, GSint iStatus, GSchar* szGroup, GSint iMood, GSint iOptions, GSchar *szGameName)
|
||||
</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 callback will be called when the client receives information about a friend that is in his friend list. This will be called on friend service loging and each time a friend is added to the friend list.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group2__1.html#a13">FriendsSend_ChangeFriend()</a> <a class="el" href="group__group2__1.html#a3">FriendsSend_Login()</a></dd></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 friend </td></tr>
|
||||
<tr><td valign=top><em>iStatus</em> </td><td>Current status of the friend </td></tr>
|
||||
<tr><td valign=top><em>szGroup</em> </td><td>Group of the friend </td></tr>
|
||||
<tr><td valign=top><em>iMood</em> </td><td>Current mood of the friend </td></tr>
|
||||
<tr><td valign=top><em>iOptions</em> </td><td>Friend options </td></tr>
|
||||
<tr><td valign=top><em>szGameName</em> </td><td>The GameName when the status is PLAYERINLOBBY, PLAYERINROOMOPEN,PLAYERINROOMCLOSE can be up to GAMELENGTH*4 in size. </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>
|
||||
@@ -0,0 +1,61 @@
|
||||
<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>Callbacks<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group6.html">Ladder Query Service</a>]</small>
|
||||
</h1>The ladder query service function callbacks.
|
||||
<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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LadderQuery.html#a0">CBLadderQueryRcv_RequestReply</a> )(GSubyte ucType, GSint iReason, GSuint uiRequestId)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the result of a ladder query to the ubi.com servers. </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="GSLadderQueryCB.h::CBLadderQueryRcv_RequestReply" ></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="GSLadderQueryCB_8h.html#a0">CBLadderQueryRcv_RequestReply</a>)(GSubyte ucType, GSint iReason, GSuint uiRequestId)
|
||||
</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 callback will be called when the client receive a response from the ubi.com data provider after asking a ladder data request. </dd></dl>
|
||||
<dl compact><dt><b>Related functions</b></dt><dd><a class="el" href="group__group6__1.html#a4">LadderQuery_SendRequest()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ucType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ucType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>uiRequestId</em> </td><td>The id of the request from wich we received results </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>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,366 @@
|
||||
<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>Callbacks<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group1.html">Login Service</a>]</small>
|
||||
</h1>The login service function callbacks.
|
||||
<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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a0">CBLoginRcv_PlayerInfo</a> )(GSubyte ubType, GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName, GSchar *szCountry, GSchar *szEmail, GSchar *szIRCID, GSchar *szIPAddress, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive information on a player. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a1">CBLoginRcv_JoinWaitModuleResult</a> )(GSubyte ubType, GSchar *szAddress, GSushort usPort, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the join wait module request. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a2">CBLoginRcv_LoginRouterResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the login request. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a3">CBLoginRcv_LoginWaitModuleResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the login wait module request. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a4">CBLoginRcv_SystemPage</a> )(GSint iSubType, GSchar *szText)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Received a system page. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a5">CBLoginRcv_LoginDisconnection</a> )()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnection from router. </em> <a href="#a5"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a6">CBLoginRcv_AccountCreationResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the account creation request. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a7">CBLoginRcv_ModifyUserResult</a> )(GSubyte ubType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the status of the user modifycation request. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__LoginCB.html#a8">CBLoginRcv_RequestMOTD</a> )(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive the message of the day. </em> <a href="#a8"></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="a6" doxytag="GSLoginCB.h::CBLoginRcv_AccountCreationResult" ></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="GSLoginCB_8h.html#a6">CBLoginRcv_AccountCreationResult</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after sending a account creation request</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a2">LoginSend_Disconnect()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORSECURE_USERNAMEEXISTS: The account name already exists.<br>
|
||||
ERRORSECURE_USERNAMEMALFORMED: The account name does not match the format rules <code>^[a-zA-Z][a-zA-Z0-9_\.-]{2,14}$</code>.<br>
|
||||
ERRORSECURE_USERNAMEFORBIDDEN: The account name contains forbidden substrings (e.g. smut)<br>
|
||||
ERRORSECURE_USERNAMERESERVED: The account name is reserved<br>
|
||||
ERRORSECURE_PASSWORDMALFORMED: The password does not match the format rules <code>^.{2,16}$</code>.<br>
|
||||
ERRORSECURE_PASSWORDFORBIDDEN: The password contains the username<br>
|
||||
ERRORSECURE_DATABASEFAILED: There is a problem with the database.<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a1" doxytag="GSLoginCB.h::CBLoginRcv_JoinWaitModuleResult" ></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="GSLoginCB_8h.html#a1">CBLoginRcv_JoinWaitModuleResult</a>)(GSubyte ubType, GSchar *szAddress, GSushort usPort, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after asking to join the wait module. The client should then call <a class="el" href="group__group1__1.html#a1">LoginSend_Connect()</a> with this szAddress and usPort.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a4">LoginSend_JoinWaitModule()</a><br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>szAddress</em> </td><td>IP address of the wait module </td></tr>
|
||||
<tr><td valign=top><em>usPort</em> </td><td>The port of the wait module </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a5" doxytag="GSLoginCB.h::CBLoginRcv_LoginDisconnection" ></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="GSLoginCB_8h.html#a5">CBLoginRcv_LoginDisconnection</a>)()
|
||||
</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 callback will be called when the client is disconnected from the router </dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSLoginCB.h::CBLoginRcv_LoginRouterResult" ></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="GSLoginCB_8h.html#a2">CBLoginRcv_LoginRouterResult</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after asking to log into the router. If you reveive a GSSCUCCESS you can then call <a class="el" href="group__group1__1.html#a4">LoginSend_JoinWaitModule()</a>.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a3">LoginSend_LoginRouter()</a><br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORSECURE_DATABASEFAILED: There is a problem with the Database.<br>
|
||||
ERRORROUTER_NOTDISCONNECTED: The player is already logged in.<br>
|
||||
ERRORSECURE_INVALIDPASSWORD: The password is not correct.<br>
|
||||
ERRORSECURE_LOCKEDACCOUNT: The account has been locked.<br>
|
||||
ERRORSECURE_INVALIDACCOUNT: The username doesn't exist.<br>
|
||||
ERRORSECURE_BANNEDACCOUNT: The account has been banned.<br>
|
||||
ERRORSECURE_BLOCKEDACCOUNT: The account has been blocked.<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSLoginCB.h::CBLoginRcv_LoginWaitModuleResult" ></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="GSLoginCB_8h.html#a3">CBLoginRcv_LoginWaitModuleResult</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after asking to login to the wait module. After receving this callback you will be fully connected to the Game Service. It's recommened that the client now call <a class="el" href="group__group1__1.html#a6">LoginSend_PlayerInfo()</a> with the players username to get his szIRCID and the correct case of his username.</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a5">LoginSend_LoginWaitModule()</a><br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a7" doxytag="GSLoginCB.h::CBLoginRcv_ModifyUserResult" ></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="GSLoginCB_8h.html#a7">CBLoginRcv_ModifyUserResult</a>)(GSubyte ubType, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after sending a user info modification request</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a9">LoginSend_ModifyAccount()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORSECURE_PASSWORDMALFORMED: The password does not match the format rules <code>^.{2,16}$</code>.<br>
|
||||
ERRORSECURE_PASSWORDFORBIDDEN: The password contains the username<br>
|
||||
ERRORSECURE_DATABASEFAILED: There is a problem with the database.<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSLoginCB.h::CBLoginRcv_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"> typedef GSvoid( * <a class="el" href="GSLoginCB_8h.html#a0">CBLoginRcv_PlayerInfo</a>)(GSubyte ubType, GSchar *szUsername, GSchar *szSurName, GSchar *szFirstName, GSchar *szCountry, GSchar *szEmail,GSchar *szIRCID, GSchar *szIPAddress, GSint iReason)
|
||||
</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 callback will be called when the client requests information on a player</dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group1__1.html#a6">LoginSend_PlayerInfo()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORROUTER_DBPROBLEM: There is a problem with the database.<br>
|
||||
ERRORROUTER_NOTREGISTERED: The username doesn't exist.<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the player in the correct case </td></tr>
|
||||
<tr><td valign=top><em>szSurName</em> </td><td>The last name of a player </td></tr>
|
||||
<tr><td valign=top><em>szFirstName</em> </td><td>The first name of the player </td></tr>
|
||||
<tr><td valign=top><em>szCountry</em> </td><td>The country of the player </td></tr>
|
||||
<tr><td valign=top><em>szEmail</em> </td><td>Email address of the player </td></tr>
|
||||
<tr><td valign=top><em>szIRCID</em> </td><td>Player's IRC ID </td></tr>
|
||||
<tr><td valign=top><em>szIPAddress</em> </td><td>Player's ip address </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a8" doxytag="GSLoginCB.h::CBLoginRcv_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"> typedef GSvoid( * <a class="el" href="GSLoginCB_8h.html#a8">CBLoginRcv_RequestMOTD</a>)(GSubyte ubType, GSchar *szUbiMOTD, GSchar *szGameMOTD, GSint iReason)
|
||||
</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 callback will be called when the client receives the MOTDs from the server. The messages will never be greater the MOTDLENGTH.</dd></dl>
|
||||
<dl compact><dt><b>Related function:</b></dt><dd><a class="el" href="group__group1__1.html#a11">LoginSend_RequestMOTD()</a></dd></dl>
|
||||
<dl compact><dt><b>Errors:</b></dt><dd>ERRORROUTER_DBPROBLEM: There is a problem with the database.<br>
|
||||
</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ubType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>szUbiMOTD</em> </td><td>The message of the day for the Ubi.com Game Service </td></tr>
|
||||
<tr><td valign=top><em>szGameMOTD</em> </td><td>The message of the day for the game. </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason for the failure if ubType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a4" doxytag="GSLoginCB.h::CBLoginRcv_SystemPage" ></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="GSLoginCB_8h.html#a4">CBLoginRcv_SystemPage</a>)(GSint iSubType, GSchar *szText)
|
||||
</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 callback will be called when the client received a system page wich is usually called by a administrator or when another player adds the client to his friend list.</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>iSubType</em> </td><td>The type of message. The possibilities are: <ul>
|
||||
<li>
|
||||
ADDEDASFRIEND<br>
|
||||
The player was added to the friend list of the other player who's name is in the szText parameter </li>
|
||||
<li>
|
||||
ADDEDASIGNOREE<br>
|
||||
The player was added to the ignore list of the other player who's name is in the szText parameter </li>
|
||||
<li>
|
||||
REMOVEDASIGNOREE<br>
|
||||
The player was removed from the ignore list of the other player who's name is in the szText parameter </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td valign=top><em>szText</em> </td><td>The actual message </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>
|
||||
@@ -0,0 +1,154 @@
|
||||
<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>Callbacks<br>
|
||||
<small>
|
||||
[<a class="el" href="group__group5.html">Persistent Storage Service</a>]</small>
|
||||
</h1>The persistent storage service function callbacks.
|
||||
<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(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a> )(GSubyte ucType, GSint iReason)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive status of the Persistent data storage login request. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a> )()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Client as been disconnected from the Persistent storage service. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Proxy reply on client request to set persistent data. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID, GSvoid *pData, GSint iSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Proxy reply on client request to get persistent data. </em> <a href="#a3"></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="a1" doxytag="GSPersistentCB.h::CBPSRcv_Disconnection" ></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="GSPersistentCB_8h.html#a1">CBPSRcv_Disconnection</a>)()
|
||||
</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 callback will be called when the client has been disconnected from the Persistent storage service </dd></dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a3" doxytag="GSPersistentCB.h::CBPSRcv_GetDataReply" ></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="GSPersistentCB_8h.html#a3">CBPSRcv_GetDataReply</a>)(GSubyte ucType, GSint iReason, GSuint iID,GSvoid *pData,GSint iSize)
|
||||
</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 callback will be called when the client ask for persistent data using the Persistent storage service</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ucType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ucType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>iID</em> </td><td>The id of the request </td></tr>
|
||||
<tr><td valign=top><em>pData</em> </td><td>Pointer to the data buffer </td></tr>
|
||||
<tr><td valign=top><em>iSize</em> </td><td>Size of the data buffer </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a0" doxytag="GSPersistentCB.h::CBPSRcv_LoginResult" ></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="GSPersistentCB_8h.html#a0">CBPSRcv_LoginResult</a>)(GSubyte ucType, GSint iReason)
|
||||
</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 callback will be called when the client receive a response from the router after asking to join the Persistent storage server </dd></dl>
|
||||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group5__1.html#a0">PSSend_Login()</a></dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ucType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>lReason</em> </td><td>The reason of failure if ucType is GSFAIL </td></tr>
|
||||
</table>
|
||||
</dl>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="a2" doxytag="GSPersistentCB.h::CBPSRcv_SetDataReply" ></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="GSPersistentCB_8h.html#a2">CBPSRcv_SetDataReply</a>)(GSubyte ucType, GSint iReason, GSuint iID)
|
||||
</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 callback will be called when the client has set data using Persistent storage service</dd></dl>
|
||||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||||
<table border="0" cellspacing="2" cellpadding="0">
|
||||
<tr><td valign=top><em>ucType</em> </td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
|
||||
<tr><td valign=top><em>iReason</em> </td><td>The reason of failure if ucType is GSFAIL </td></tr>
|
||||
<tr><td valign=top><em>iID</em> </td><td>The id of the request </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>
|
||||
@@ -0,0 +1,77 @@
|
||||
<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>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(* </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"> </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>
|
||||
|
||||
</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> </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> </td><td>Identifier of the request being replied </td></tr>
|
||||
<tr><td valign=top><em>rResult</em> </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> </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> </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 - ©UbiSoft Entertainment 2002 </i><br>
|
||||
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
246
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/gs-sdk-doc.css
Normal file
246
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/gs-sdk-doc.css
Normal file
@@ -0,0 +1,246 @@
|
||||
/******************************************************************/
|
||||
/* */
|
||||
/* File.........: gs-sdk-doc.css */
|
||||
/* Author.......: Guillaume Plante <gplante@ubisoft.com> */
|
||||
/* Description..: Cascading style sheet description file for */
|
||||
/* the GameService SDKs documentation generation. */
|
||||
/******************************************************************/
|
||||
|
||||
BODY {
|
||||
font-family: Verdana,Helvetica;
|
||||
font-size: 12px;
|
||||
background: white;
|
||||
color: black
|
||||
}
|
||||
|
||||
/* target links */
|
||||
A:link { BACKGROUND: none; COLOR: #273C56; FONT-FAMILY: Verdana, Helvetica; TEXT-DECORATION: underline}
|
||||
A:active { BACKGROUND: none; COLOR: #273C56; FONT-FAMILY: Verdana, Helvetica; TEXT-DECORATION: underline}
|
||||
A:visited { BACKGROUND: none; COLOR: #273C56; FONT-FAMILY: Verdana, Helvetica; TEXT-DECORATION: underline}
|
||||
A:hover { BACKGROUND: none; COLOR: #7B7B7B; FONT-FAMILY: Verdana, Helvetica; TEXT-DECORATION: underline}
|
||||
|
||||
/* Header 1 */
|
||||
H1 {
|
||||
text-align: center;
|
||||
color: #273C56;
|
||||
font-family: Verdana,Helvetica;
|
||||
font-size : 14px
|
||||
}
|
||||
|
||||
/* Header 2 */
|
||||
H2 {
|
||||
font-family: Verdana,Helvetica;
|
||||
color: #273C56;
|
||||
font-size : 14px
|
||||
}
|
||||
|
||||
/* Header 3 */
|
||||
H3 {
|
||||
font-family: Verdana,Helvetica;
|
||||
color: #273C56;
|
||||
font-size : 10px
|
||||
}
|
||||
|
||||
|
||||
|
||||
CAPTION { font-weight: bold }
|
||||
|
||||
DIV.qindex { width: 100%;
|
||||
background-color: #AAAEC4;
|
||||
border: 4px solid #AAAEC4;
|
||||
text-align: center;
|
||||
margin-bottom: 2px;
|
||||
color: #2A2F61;
|
||||
font-size : 12px
|
||||
}
|
||||
|
||||
A.qindex { text-decoration: none; font-weight: bold; color: #2A2F61 }
|
||||
A.qindex:visited { text-decoration: none; font-weight: bold; color: #2A2F61 }
|
||||
A.qindex:hover { text-decoration: none; background-color: #DEE0EC }
|
||||
|
||||
A.qindexHL { text-decoration: none; font-weight: bold; background-color: #ACAFC6; color: #ffffff }
|
||||
A.qindexHL:hover { text-decoration: none; background-color: #ACAFC6; color: #ffffff }
|
||||
A.qindexHL:visited { text-decoration: none; background-color: #ACAFC6; color: #ffffff }
|
||||
|
||||
A.el { text-decoration: none; font-weight: bold }
|
||||
A.elRef { font-weight: bold }
|
||||
A.code { text-decoration: none; font-weight: normal; color: #4444ee }
|
||||
A.codeRef { font-weight: normal; color: #4444ee }
|
||||
|
||||
DL.el { margin-left: -1cm }
|
||||
DIV.fragment {
|
||||
width: 98%;
|
||||
border: 1px solid #CCCCCC;
|
||||
background-color: #f5f5f5;
|
||||
padding-left: 4px;
|
||||
margin: 4px
|
||||
}
|
||||
|
||||
DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
|
||||
|
||||
/* function prototype */
|
||||
TD.md { font-size: 12px; background-color: #f2f2ff; font-weight: bold }
|
||||
|
||||
/* arguments name */
|
||||
TD.mdname {font-size: 11px; background-color: #f2f2ff; font-weight: bold; color: #7B7B7B }
|
||||
|
||||
/* arguments name (from a predefined type) */
|
||||
TD.mdname1 {font-size: 11px; background-color: #f2f2ff; font-weight: bold; color: #7B7B7B }
|
||||
|
||||
DIV.groupHeader {color: #476A91; margin-left: 14px; margin-top: 12px; margin-bottom: 6px; font-weight: bold;font-family: Verdana,Helvetica;font-size: 12px }
|
||||
DIV.groupText { color: black; margin-left: 12px; font-style: italic; font-size: smaller; font-family: Verdana,Helvetica;font-size: 12px }
|
||||
|
||||
|
||||
/* file list - file names */
|
||||
TD.indexkey {
|
||||
background-color: #eeeeff;
|
||||
font-weight: bold;
|
||||
padding-right : 10px;
|
||||
font-size : 12px;
|
||||
padding-top : 2px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px
|
||||
}
|
||||
|
||||
/* file list - file description */
|
||||
TD.indexvalue {
|
||||
background-color: #eeeeff;
|
||||
font-style: italic;
|
||||
padding-right : 10px;
|
||||
padding-top : 2px;
|
||||
font-size : 12px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px
|
||||
}
|
||||
|
||||
TR.memlist {
|
||||
font-size : 12px;
|
||||
background-color: #f0f0f0
|
||||
}
|
||||
|
||||
|
||||
/* source code definitions */
|
||||
P.formulaDsp { text-align: center; }
|
||||
IMG.formulaDsp { }
|
||||
IMG.formulaInl { vertical-align: middle; }
|
||||
SPAN.keyword { color: #008000 }
|
||||
SPAN.keywordtype { color: #604020 }
|
||||
SPAN.keywordflow { color: #e08000 }
|
||||
SPAN.comment { color: #800000 }
|
||||
SPAN.preprocessor { color: #806020 }
|
||||
SPAN.stringliteral { color: #002080 }
|
||||
SPAN.charliteral { color: #008080 }
|
||||
|
||||
|
||||
.mdTable {
|
||||
border: 1px solid #868686;
|
||||
background-color: #f2f2ff;
|
||||
font-size : 12px
|
||||
}
|
||||
|
||||
.mdRow {
|
||||
padding: 8px 20px;
|
||||
font-size : 12px
|
||||
}
|
||||
|
||||
.mdescLeft {
|
||||
font-size: 11px;
|
||||
font-family: Verdana,Helvetica;
|
||||
background-color: #FAFAFA;
|
||||
padding-left: 8px;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px
|
||||
}
|
||||
|
||||
|
||||
.mdescRight {
|
||||
font-size: 11px;
|
||||
font-family: Verdana,Helvetica;
|
||||
font-style: italic;
|
||||
background-color: #FAFAFA;
|
||||
padding-left: 4px;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px;
|
||||
padding-bottom: 0px;
|
||||
padding-right: 8px
|
||||
}
|
||||
|
||||
|
||||
.memItemLeft {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-style: solid;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-family: Verdana,Helvetica;
|
||||
font-size: 11px
|
||||
}
|
||||
|
||||
|
||||
.memItemRight {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-style: solid;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-family: Verdana,Helvetica;
|
||||
font-size: 11px
|
||||
}
|
||||
|
||||
|
||||
.search { color: #0000ee;
|
||||
font-weight: bold;
|
||||
font-size: 11px
|
||||
}
|
||||
|
||||
|
||||
FORM.search { font-size: 10px;
|
||||
margin-bottom: 0px;
|
||||
margin-top: 0px
|
||||
}
|
||||
|
||||
|
||||
INPUT.search { font-size: 10px;
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
background-color: #eeeeff
|
||||
}
|
||||
|
||||
TD.tiny { font-size: 10px
|
||||
}
|
||||
|
||||
|
||||
25
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/index.html
Normal file
25
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/index.html
Normal file
@@ -0,0 +1,25 @@
|
||||
<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="qindexHL" 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>gs-sdk-base </h1>
|
||||
<p>
|
||||
<h2><a class="anchor" name="intro">
|
||||
Introduction</a></h2>
|
||||
ubi.com GameService base SDK<h2><a class="anchor" name="description">
|
||||
Description</a></h2>
|
||||
This SDK is the interface to the basic ubi.com services.<ul>
|
||||
<li>The <em><b>login service</b></em> allow you to connect and authenticate users on the ubi.com network. This service also provide the functionalities to create and manage ubi.com accounts.</li><li>The <em><b>friends service</b></em> allow you to manage a list of friends, send private message (pages) to them, in short it provides buddy-list and instant-messaging functionalities.</li><li>The <em><b>lobby service</b></em> is the core of the ubi.com match-making functionalities. This service will enable you to join game lobbies,join, create and manage rooms.</li><li>The <em><b>persistent storage service</b></em> allows you to store/retrieve permanent game information on the ubi.com network.</li><li>The <em><b>ladder query service</b></em> allows you to retieve ladder information that were previously submitted to ubi.com.</li><li>The <em><b>remote algorithm execution service</b></em> allows you to execute custom algorithms stored on ubi.com. </li></ul>
|
||||
<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>
|
||||
56
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/modules.html
Normal file
56
Ubisoft.com/GSServices/sdks/gs-sdk-base/doc-api/modules.html
Normal file
@@ -0,0 +1,56 @@
|
||||
<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="qindexHL" 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>gs-sdk-base Modules</h1>Here is a list of all modules:<ul>
|
||||
<li><a class="el" href="group__group1.html">Login Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group1__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group1__2.html">Callback registration</a>
|
||||
<li><a class="el" href="group__group__LoginCB.html">Callbacks</a>
|
||||
</ul>
|
||||
<li><a class="el" href="group__group2.html">Friends Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group2__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group2__2.html">Callback registration</a>
|
||||
<li><a class="el" href="group__group__FriendCB.html">Callbacks</a>
|
||||
</ul>
|
||||
<li><a class="el" href="group__group4.html">Lobby Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group4__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group4__2.html">Callback registration</a>
|
||||
<li><a class="el" href="group__group__LobbyCB.html">Callbacks</a>
|
||||
</ul>
|
||||
<li><a class="el" href="group__group5.html">Persistent Storage Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group5__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group5__2.html">Callback registration</a>
|
||||
<li><a class="el" href="group__group__PSCB.html">Callbacks</a>
|
||||
</ul>
|
||||
<li><a class="el" href="group__group6.html">Ladder Query Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group6__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group6__2.html">Results fetching</a>
|
||||
<li><a class="el" href="group__group6__3.html">Callback registration</a>
|
||||
<li><a class="el" href="group__group__LadderQuery.html">Callbacks</a>
|
||||
</ul>
|
||||
<li><a class="el" href="group__group7.html">Remote Algorithm Execution Service</a>
|
||||
<ul>
|
||||
<li><a class="el" href="group__group7__1.html">Functions</a>
|
||||
<li><a class="el" href="group__group7__2.html">Type Definition</a>
|
||||
<li><a class="el" href="group__group__RAECB.html">Callbacks</a>
|
||||
</ul>
|
||||
</ul>
|
||||
<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>
|
||||
@@ -0,0 +1,21 @@
|
||||
<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>LADDER_FILTER Member List</h1>This is the complete list of members for <a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a>, including all inherited members.<table>
|
||||
<tr class="memlist"><td><a class="el" href="structLADDER__FILTER.html#o1">eOperator</a></td><td><a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="structLADDER__FILTER.html#o2">iValue</a></td><td><a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="structLADDER__FILTER.html#o0">szFieldName</a></td><td><a class="el" href="structLADDER__FILTER.html">LADDER_FILTER</a></td><td></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>
|
||||
@@ -0,0 +1,43 @@
|
||||
<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>LADDER_FILTER Struct Reference</h1>Ladder filter structure.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a>></code>
|
||||
<p>
|
||||
<a href="structLADDER__FILTER-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="LADDER_FILTER::szFieldName" ></a>
|
||||
GSchar </td><td class="memItemRight" valign=bottom><a class="el" href="structLADDER__FILTER.html#o0">szFieldName</a> [LADDER_FIELDNAME_LENGTH]</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the field that need to be compared against reference value. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o1" doxytag="LADDER_FILTER::eOperator" ></a>
|
||||
<a class="el" href="LadderDefines_8h.html#a8">E_FILTER_OPERATOR</a> </td><td class="memItemRight" valign=bottom><a class="el" href="structLADDER__FILTER.html#o1">eOperator</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Logical operator to do comparison. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o2" doxytag="LADDER_FILTER::iValue" ></a>
|
||||
GSint </td><td class="memItemRight" valign=bottom><a class="el" href="structLADDER__FILTER.html#o2">iValue</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference value used to filter. <br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This structure defines a ladder filter that can be used with the fonction <a class="el" href="group__group6__1.html#a10">LadderQuery_AddFilterConstraint()</a> . It is used to filter results based on a numeric value using the operators EQUAL,ABOVE or BELOW defined in the E_FILTER_OPERATOR enumeration.
|
||||
<p>
|
||||
<hr>The documentation for this struct was generated from the following file:<ul>
|
||||
<li><a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,21 @@
|
||||
<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>LADDER_ROW Member List</h1>This is the complete list of members for <a class="el" href="structLADDER__ROW.html">LADDER_ROW</a>, including all inherited members.<table>
|
||||
<tr bgcolor="#f0f0f0"><td><b>player</b> (defined in <a class="el" href="structLADDER__ROW.html">LADDER_ROW</a>)</td><td><a class="el" href="structLADDER__ROW.html">LADDER_ROW</a></td><td></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>valueCount</b> (defined in <a class="el" href="structLADDER__ROW.html">LADDER_ROW</a>)</td><td><a class="el" href="structLADDER__ROW.html">LADDER_ROW</a></td><td></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td><b>values</b> (defined in <a class="el" href="structLADDER__ROW.html">LADDER_ROW</a>)</td><td><a class="el" href="structLADDER__ROW.html">LADDER_ROW</a></td><td></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>
|
||||
@@ -0,0 +1,40 @@
|
||||
<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>LADDER_ROW Struct Reference</h1>Ladder row representation.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a>></code>
|
||||
<p>
|
||||
<a href="structLADDER__ROW-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="LADDER_ROW::player" ></a>
|
||||
GSchar </td><td class="memItemRight" valign=bottom><b>player</b> [NAMELENGTH]</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o1" doxytag="LADDER_ROW::valueCount" ></a>
|
||||
GSushort </td><td class="memItemRight" valign=bottom><b>valueCount</b></td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o2" doxytag="LADDER_ROW::values" ></a>
|
||||
GSint * </td><td class="memItemRight" valign=bottom><b>values</b></td></tr>
|
||||
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This structure defines the representation of a row of ladder values. It is used by the LobbyRcv_MatchFinalResult callback.
|
||||
<p>
|
||||
<hr>The documentation for this struct was generated from the following file:<ul>
|
||||
<li><a class="el" href="LadderDefines_8h-source.html">LadderDefines.h</a></ul>
|
||||
<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>
|
||||
@@ -0,0 +1,20 @@
|
||||
<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>RAE_VALUE Member List</h1>This is the complete list of members for <a class="el" href="structRAE__VALUE.html">RAE_VALUE</a>, including all inherited members.<table>
|
||||
<tr class="memlist"><td><a class="el" href="structRAE__VALUE.html#o0">dataType</a></td><td><a class="el" href="structRAE__VALUE.html">RAE_VALUE</a></td><td></td></tr>
|
||||
<tr class="memlist"><td><a class="el" href="structRAE__VALUE.html#o1">intValue</a></td><td><a class="el" href="structRAE__VALUE.html">RAE_VALUE</a></td><td></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>
|
||||
@@ -0,0 +1,35 @@
|
||||
<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>RAE_VALUE Struct Reference</h1>INPUT/OUTPUT Element.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="RemoteAlgorithmDefines_8h-source.html">RemoteAlgorithmDefines.h</a>></code>
|
||||
<p>
|
||||
<a href="structRAE__VALUE-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="RAE_VALUE::dataType" ></a>
|
||||
RAE_DATATYPE </td><td class="memItemRight" valign=bottom><a class="el" href="structRAE__VALUE.html#o0">dataType</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of data this node contains. <br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
This structure defines the value elements that are to be used as inputs and outputs to the executed algorithm. This allows to create arrays of multiple different type of data (once the structure handles more than just integers).
|
||||
<p>
|
||||
<hr>The documentation for this struct was generated from the following file:<ul>
|
||||
<li><a class="el" href="RemoteAlgorithmDefines_8h-source.html">RemoteAlgorithmDefines.h</a></ul>
|
||||
<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