Main Page | Modules | Class List | File List | Class Members | File Members

# GSClientLibrary.h File Reference

Available functions for basic ubi.com services usage. More...

`#include "GSErrors.h"`
`#include "GSLoginCB.h"`
`#include "GSFriendsCB.h"`
`#include "GSLobbyCB.h"`
`#include "GSPersistentCB.h"`
`#include "GSLadderQueryCB.h"`
`#include "GSRemoteAlgorithmCB.h"`
`#include "LadderDefines.h"`
`#include "RemoteAlgorithmDefines.h"`

Go to the source code of this file.

## Functions
GSbool | GSClientLibrary_Initialize ()
| Initialisation function for the client library.
GSbool | GSClientLibrary_Uninitialize ()
| Free memory.
GSbool | GSGetLocalIPAddress (GSchar *szIPAddress)
| Get local ip address of the client.
GSbool | Login_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
| Update connection status-messages handling relating to the login service.
GSbool | LoginSend_Connect (const GSchar *szAddress, GSushort usPort)
| Connect to the router.
GSbool | LoginSend_Disconnect ()
| Disconnect from the router.
GSbool | LoginSend_LoginRouter (const GSchar *szUsername, const GSchar *szPassword, const GSchar *szVersion, GSbool bPublicIP=GS_TRUE)
| Login to the router.
GSbool | LoginSend_JoinWaitModule ()
| Ask to join the wait module.
GSbool | LoginSend_LoginWaitModule (const GSchar *szUsername)
| Login to the wait module.
GSbool | LoginSend_PlayerInfo (const GSchar *szUsername)
| Get player account information.
GSbool | LoginSend_Sleep ()
| Put player in sleep mode.
GSbool | LoginSend_WakeUp ()
| Put player in awake mode.
GSbool | LoginSend_ModifyAccount (const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)
| Modify player informations.
GSbool | LoginSend_CreateAccount (const GSchar *szVersion, const GSchar *szUsername, const GSchar *szPassword, const GSchar *szFirstName, const GSchar *szLastName, const GSchar *szEmail, const GSchar *szCountry)
| Account creation.
GSbool | LoginSend_RequestMOTD (const GSchar *szLanguage)
| Request the message of the day.
GSbool | LoginFix_PlayerInfo (CBLoginRcv_PlayerInfo fPlayerInfo)
| Set the function name for the callback.
GSbool | LoginFix_JoinWaitModuleResult (CBLoginRcv_JoinWaitModuleResult fJoinWaitModuleResult)
| Set the function name for the callback.
GSbool | LoginFix_LoginRouterResult (CBLoginRcv_LoginRouterResult fLoginRouterResult)
| Set the function name for the callback.
GSbool | LoginFix_LoginWaitModuleResult (CBLoginRcv_LoginWaitModuleResult fLoginWaitModuleResult)
| Set the function name for the callback.
GSbool | LoginFix_SystemPage (CBLoginRcv_SystemPage fSystemPage)
| Set the function name for the callback.
GSbool | LoginFix_LoginDisconnection (CBLoginRcv_LoginDisconnection fLoginDisconnection)
| Set the function name for the callback.
GSbool | LoginFix_LoginAccountCreationResult (CBLoginRcv_AccountCreationResult fLoginCreateAccount)
| Set the function name for the callback.
GSbool | LoginFix_ModifyUserResult (CBLoginRcv_ModifyUserResult fLoginModifyUser)
| Set the function name for the callback.
GSbool | LoginFix_RequestMOTD (CBLoginRcv_RequestMOTD fRequestMOTD)
| Set the function name for the callback.
GSbool | Friends_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
| Update connection status-messages handling relating to the friend service.
GSbool | FriendsSend_Connect ()
| This function is deprecated.
GSbool | FriendsSend_Disconnect ()
| Disconnect from the friends service.
GSbool | FriendsSend_Login (GSint lStatus=0, GSint lMood=0)
| Log into the friends service.
GSbool | FriendsSend_AddFriend (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)
| Add a new friend.
GSbool | FriendsSend_DelFriend (const GSchar *szUsername)
| Remove a friend from friend list.
GSbool | FriendsSend_FriendList ()
| Get all friends in friend list.
GSRESULT | FriendsSend_IgnorePlayer (const GSchar *szPlayer)
| Adds someone to the player's ignore-list.
GSRESULT | FriendsSend_UnignorePlayer (const GSchar *szPlayer)
| Removes someone to the player's ignore-list.
GSRESULT | FriendsSend_ListIgnoredPlayers ()
| Retrieves the ignore-list of the player.
GSbool | FriendsSend_PagePlayer (const GSchar *szUsername, const GSchar *szMessage)
| Send a page to a friend.
GSbool | FriendsSend_PeerPlayer (const GSchar *szUsername, GSvoid *p_Buffer, GSuint uiLength)
| Send data to a friend.
GSbool | FriendsSend_StatusChange (GSint iStatus, GSint iMood)
| Change the player status.
GSbool | FriendsSend_ChangeFriend (const GSchar *szUsername, const GSchar *szGroup, GSint iOptions)
| Change friend properties.
GSbool | FriendsSend_SearchPlayer (const GSchar *szUsername, const GSchar *szSurName, const GSchar *szFirstName, const GSchar *szCountry, const GSchar *szEmail, GSint iSex, const GSchar *szGame)
| Search for a player.
GSbool | FriendsSend_GetPlayerScores (const GSchar *szUsername)
| Get player score.
GSbool | FriendsFix_LoginResult (CBFriendsRcv_LoginResult fLoginResult)
| Set the function name for the callback.
GSbool | FriendsFix_AddFriend (CBFriendsRcv_AddFriend fAddFriend)
| Set the function name for the callback.
GSbool | FriendsFix_DelFriend (CBFriendsRcv_DelFriend fDelFriend)
| Set the function name for the callback.
GSvoid | FriendsFix_IgnorePlayer (CBFriendsRcv_IgnorePlayer fIgnorePlayer)
| Set the function name for the callback.
GSvoid | FriendsFix_UnignorePlayer (CBFriendsRcv_UnignorePlayer fUnignorePlayer)
| Set the function name for the callback.
GSvoid | FriendsFix_ListIgnoredPlayers (CBFriendsRcv_ListIgnoredPlayers fListIgnoredPlayers)
| Set the function name for the callback.
GSvoid | FriendsFix_IgnoredPlayer (CBFriendsRcv_IgnoredPlayer fIgnoredPlayer)
| Set the function name for the callback.
GSbool | FriendsFix_Page (CBFriendsRcv_Page fPage)
| Set the function name for the callback.
GSbool | FriendsFix_PagePlayer (CBFriendsRcv_PagePlayer fPagePlayer)
| Set the function name for the callback.
GSbool | FriendsFix_PeerMsg (CBFriendsRcv_PeerMsg fPeerMsg)
| Set the function name for the callback.
GSbool | FriendsFix_PeerPlayer (CBFriendsRcv_PeerPlayer fPeerPlayer)
| Set the function name for the callback.
GSbool | FriendsFix_StatusChange (CBFriendsRcv_StatusChange fStatusChange)
| Set the function name for the callback.
GSbool | FriendsFix_ChangeFriend (CBFriendsRcv_ChangeFriend fChangeFriend)
| Set the function name for the callback.
GSbool | FriendsFix_UpdateFriend (CBFriendsRcv_UpdateFriend fUpdateFriend)
| Set the function name for the callback.
GSbool | FriendsFix_SearchPlayer (CBFriendsRcv_SearchPlayer fSearchPlayer)
| Set the function name for the callback.
GSbool | FriendsFix_ScoreCard (CBFriendsRcv_ScoreCard fScoreCard)
| Set the function name for the callback.
GSbool | Lobby_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
| Update connection status-messages handling relating to the lobby service.
GSbool | LobbySend_Connect ()
| This function is deprecated.
GSbool | LobbySend_Disconnect (GSint iLobbyServerID)
| Disconnect from the lobby server.
GSbool | LobbySend_DisconnectAll ()
| Disconnect from the lobby server.
GSbool | LobbySend_Login (const GSchar *szGames, GSbool bPublicIP=GS_TRUE, GSushort usPlayerStatus=0)
| This function is used to log into the lobby service.
GSbool | LobbySend_JoinLobby (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSint iconfig=0)
| Join a lobby.
GSbool | LobbySend_JoinRoom (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSbool bVisitor, const GSchar *szVersion, GSint iconfig=0)
| Join a room.
GSbool | LobbySend_LeaveGroup (GSint iGroupID, GSint iLobbyServerID)
| Leave a group.
GSbool | LobbySend_CreateRoom (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)
| Create a room.
GSbool | LobbySend_StartMatch (GSint iGroupID, GSint iLobbyServerID, GSuint uiMode=0)
| Tell the lobby server that you are ready to start the match.
GSbool | LobbySend_MatchFinish (GSint iGroupID, GSint iLobbyServerID)
| Tell the lobby server that you are finishing the match.
GSbool | LobbySend_NewMaster (GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)
| Tell the lobby server that you are ready to start the match.
GSbool | LobbySend_PlayerMatchStarted (GSint iGroupID, GSint iLobbyServerID)
| Tell the lobby server that a match is finished.
GSbool | LobbySend_PlayerMatchFinished (GSint iGroupID, GSint iLobbyServerID)
| Tell the lobby server that a match is finished.
GSbool | LobbySend_PlayerKick (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)
| Tell the lobby server that to kick a player.
GSbool | LobbySend_GetParentGroupID (GSint iGroupID, GSint iLobbyServerID)
| Tell the lobby server that to get a parent group id.
GSbool | LobbySend_UpdateRoomConfig (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)
| Tell the lobby server to update room configuration flags.
GSbool | LobbySend_GetGroupInfo (GSint iGroupID, GSint iLobbyServerID, GSint iconfig)
| Get information about a group.
GSbool | LobbySend_GetAlternateGroupInfo (GSint iGroupID, GSint iLobbyServerID)
| Get information about a group.
GSbool | LobbySend_InitMatchResults (GSuint uiMatchID)
| Initialize the library score submission system.
GSbool | LobbySend_SetMatchResult (const GSchar *szUserName, GSuint uiFieldID, GSint iFieldValue)
| Set results for a player in a match.
GSbool | LobbySend_SubmitMatchResult (GSint iGroupID, GSint iLobbyServerID)
| Send the compiled scores of a match to the lobby server.
GSbool | LobbySend_ClearMatchResult ()
| Unload the internal score submission system.
GSbool | LobbySend_UpdatePing (GSint iGroupID, GSint iLobbyServerID, GSushort usPing)
| Send a new ping value to the server.
GSbool | LobbySend_GameStart (GSint iGroupID, GSint iLobbyServerID)
| Send a message to inform the lobby server that the game is started.
GSbool | LobbySend_GameConnected (GSint iGroupID, GSint iLobbyServerID)
| Send a message to inform the lobby server that you are connected.
GSbool | LobbySend_GameFinish (GSint iGroupID, GSint iLobbyServerID)
| Send a message to inform the lobby server about the end of the game.
GSbool | LobbySend_GameReady (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)
| Send a message to inform the lobby server about connection readiness.
GSbool | LobbySend_UpdateGameInfo (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)
| Tell the lobby server about new game information.
GSbool | LobbySend_PlayerBan (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)
| Ban a player from a group.
GSbool | LobbySend_PlayerUnBan (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName)
| Un-Ban a player from a group.
GSbool | LobbySend_GetPlayerBannedList (GSint iGroupID, GSint iLobbyServerID)
| Get banned player list.
GSbool | LobbySend_SetPlayerInfo (GSvoid *vpPlayerInfo, GSint iPlayerInfoSize)
| Set player specific information.
GSbool | LobbySend_GetPlayerGroups (GSchar *szUsername)
| Set player specific information.
GSbool | LobbySend_ChangeRequestedLobbies (const GSchar *szGames)
| This function is used to get a new list of available lobbies for a game.
GSbool | LobbyFix_LoginReply (CBLobbyRcv_LoginReply fLoginReply)
| Set the function name for te callback.
GSbool | LobbyFix_LobbyDisconnection (CBLobbyRcv_LobbyDisconnection fLobbyDisconnection)
| Set the function name for the callback.
GSbool | LobbyFix_LobbyDisconnectAll (CBLobbyRcv_LobbyDisconnectAll fLobbyDisconnectAll)
| Set the function name for the callback.
GSbool | LobbyFix_CreateRoomReply (CBLobbyRcv_CreateRoomReply fCreateRoomReply)
| Set the function name for the callback.
GSbool | LobbyFix_NewRoom (CBLobbyRcv_NewRoom fNewRoom)
| Set the function name for the callback.
GSbool | LobbyFix_NewLobby (CBLobbyRcv_NewLobby fNewLobby)
| Set the function name for the callback.
GSbool | LobbyFix_RoomInfo (CBLobbyRcv_RoomInfo fRoomInfo)
| Set the function name for the callback.
GSbool | LobbyFix_LobbyInfo (CBLobbyRcv_LobbyInfo fLobbyInfo)
| Set the function name for the callback.
GSbool | LobbyFix_GroupInfoGet (CBLobbyRcv_GroupInfoGet fGroupInfoGet)
| Set the function name for the callback.
GSbool | LobbyFix_JoinRoomReply (CBLobbyRcv_JoinRoomReply fJoinRoomReply)
| Set the function name for the callback.
GSbool | LobbyFix_JoinLobbyReply (CBLobbyRcv_JoinLobbyReply fJoinLobbyReply)
| Set the function name for the callback.
GSbool | LobbyFix_MemberJoined (CBLobbyRcv_MemberJoined fMemberJoined)
| Set the function name for the callback.
GSbool | LobbyFix_MemberLeave (CBLobbyRcv_MemberLeave fMemberLeave)
| Set the function name for the callback.
GSbool | LobbyFix_StartMatchReply (CBLobbyRcv_StartMatchReply fStartMatchReply)
| Set the function name for the callback.
GSbool | LobbyFix_GroupRemove (CBLobbyRcv_GroupRemove fGroupRemove)
| Set the function name for the callback.
GSbool | LobbyFix_MasterNewReply (CBLobbyRcv_MasterNewReply fMasterNewReply)
| Set the function name for the callback.
GSbool | LobbyFix_MasterChanged (CBLobbyRcv_MasterChanged fMasterChanged)
| Set the function name for the callback.
GSbool | LobbyFix_MatchFinishReply (CBLobbyRcv_MatchFinishReply fMatchFinishReply)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerKickReply (CBLobbyRcv_PlayerKickReply fPlayerKickReply)
| Set the function name for the callback.
GSbool | LobbyFix_KickOut (CBLobbyRcv_KickOut fKickOut)
| Set the function name for the callback.
GSbool | LobbyFix_ParentGroupIDReply (CBLobbyRcv_ParentGroupIDReply fParentGroupIDReply)
| Set the function name for the callback.
GSbool | LobbyFix_GetAlternateGroupInfoReply (CBLobbyRcv_GetAlternateGroupInfoReply fGetAlternateGroupInfoReply)
| Set the function name for the callback.
GSbool | LobbyFix_GroupLeaveReply (CBLobbyRcv_GroupLeaveReply fGroupLeaveReply)
| Set the function name for the callback.
GSbool | LobbyFix_GroupConfigUpdate (CBLobbyRcv_GroupConfigUpdate fGroupConfigUpdate)
| Set the function name for the callback.
GSbool | LobbyFix_MatchStarted (CBLobbyRcv_MatchStarted fMatchStarted)
| Set the function name for the callback.
GSbool | LobbyFix_UpdateRoomConfigReply (CBLobbyRcv_UpdateRoomConfigReply fUpdateRoomConfigReply)
| Set the function name for the callback.
GSbool | LobbyFix_SubmitMatchResultReply (CBLobbyRcv_SubmitMatchResultReply fSubmitMatchResultReply)
| Set the function name for the callback.
GSbool | LobbyFix_UpdatePing (CBLobbyRcv_UpdatePing fUpdatePing)
| Set the function name for the callback.
GSbool | LobbyFix_GameStartReply (CBLobbyRcv_StartGameReply fStartGameReply)
| Set the function name for the callback.
GSbool | LobbyFix_GameReadyReply (CBLobbyRcv_GameReadyReply fGameReadyReply)
| Set the function name for the callback.
GSbool | LobbyFix_GameStarted (CBLobbyRcv_GameStarted fGameStarted)
| Set the function name for the callback.
GSbool | LobbyFix_NewGameMember (CBLobbyRcv_NewGameMember fNewGameMember)
| Set the function name for the callback.
GSbool | LobbyFix_UpdateGameInfoReply (CBLobbyRcv_UpdateGameInfoReply fUpdateGameInfoReplyCB)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerBanReply (CBLobbyRcv_PlayerBanReply fPlayerBanReplyCB)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerUnBanReply (CBLobbyRcv_PlayerUnBanReply fPlayerUnBanReplyCB)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerBanList (CBLobbyRcv_PlayerBanList fPlayerBanListCB)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerBanned (CBLobbyRcv_PlayerBanned fPlayerBannedCB)
| Set the function name for the callback.
GSbool | LobbyFix_MatchReady (CBLobbyRcv_MatchReady fMatchReadyCB)
| Set the function name for the callback.
GSbool | LobbyFix_InfoRefresh (CBLobbyRcv_InfoRefresh fInfoRefresh)
| Set the function name for the callback.
GSbool | LobbyFix_SetPlayerInfoReply (CBLobbyRcv_SetPlayerInfoReply fSetPlayerInfoReply)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerInfoUpdate (CBLobbyRcv_PlayerInfoUpdate fPlayerInfoUpdate)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerGroupList (CBLobbyRcv_PlayerGroupList fPlayerGroupListCB)
| Set the function name for the callback.
GSbool | LobbyFix_PlayerStatusUpdate (CBLobbyRcv_PlayerStatusUpdate fPlayerStatusUpdate)
| Set the function name for the callback.
GSbool | LobbyFix_FinalMatchResults (CBLobbyRcv_FinalMatchResults fFinalMatchResults)
GSbool | PSSend_Login ()
| Login to the persistent storage service.
GSbool | PSSend_Disconnect ()
| Disconnect from the persistent storage service.
GSbool | PS_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
| Update connection status-messages handling relating to the persistent data storage service.
GSuint | PSSend_GetPrivateData (const GSchar *szGame, GSint iEventID, GSint iRecordID)
| Get the private data related to a player.
GSuint | PSSend_SetPrivateData (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)
| Set the private data related to a player.
GSuint | PSSend_GetPublicData (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSchar *szUsername=0)
| Get the public data related to a player.
GSuint | PSSend_SetPublicData (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)
| Set the public data related to a player.
GSbool | PSFix_LoginResult (CBPSRcv_LoginResult fPSLoginResult)
| Set the function name for the callback.
GSbool | PSFix_Disconnection (CBPSRcv_Disconnection fPSDisconnection)
| Set the function name for the callback.
GSbool | PSFix_SetDataReply (CBPSRcv_SetDataReply fSetDataReply)
| Set the function name for the callback.
GSbool | PSFix_GetDataReply (CBPSRcv_GetDataReply fGetDataReply)
| Set the function name for the callback.
GSbool | LadderQuery_Initialize (GSchar *szLocale)
| Initialization function for the ladder query service.
GSbool | LadderQuery_Uninitialize ()
| Uninitialization function for the ladder query service.
GSbool | LadderQuery_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)
| Update connection status related to the ladder query service.
GSbool | LadderQuery_CreateRequest (GSchar *szGameName, GSuint uiEvent=0, GSuint uiMode=0)
| Create a basic ladder query request.
GSuint | LadderQuery_SendRequest ()
| Send a request over the network.
GSbool | LadderQuery_RequestPivotUser (const GSchar *pszEntry, GSuint uiNumberOfEntries)
| Requesting an ordered list of entries around a pivot (username).
GSbool | LadderQuery_RequestPivotRow (GSuint uiRowNumber, GSuint uiNumberOfEntries)
| Requesting an ordered list of entries around a pivot (row number).
GSbool | LadderQuery_RequestSet (const GSchar *pszEntries[], GSuint uiNumberOfEntries)
| Requesting a pre-defined set of entries.
GSbool | LadderQuery_RequestOrderedList (GSuint uiFirstEntry, GSuint uiNumberOfEntries)
| Requesting an ordered list of entries from a starting index (row number).
GSbool | LadderQuery_AddSortConstraint (const GSchar *pszField, GSbool bSortDirection)
| Add a sort constraint to a created request.
GSbool | LadderQuery_AddFilterConstraint (const LADDER_FILTER *pLadderFilter[], GSuint uiListOfFilters)
| Add a filter constraint to a created request.
GSbool | LadderQuery_AddDisplayConstraint (const GSchar *pszFields[], GSuint uiNumberOfFields)
| Add a display constraint to a created request.
GSbool | LadderQuery_GetResultSearchCount (GSuint uiRequestID, GSuint &uiCount)
| Get the request search count.
GSbool | LadderQuery_GetResultEntryCount (GSuint uiRequestID, GSuint &uiCount)
| Get the request entry count.
GSbool | LadderQuery_GetResultFieldCaption (GSuint uiRequestID, const GSchar *pszField, GSchar *pszCaption)
| Get the pretty name of a field.
GSbool | LadderQuery_StartResultEntryEnumeration (GSuint uiRequestID, GSuint uiStartEntry=0)
| Start the entry enumeration.
GSbool | LadderQuery_NextResultEntry (GSuint uiRequestID)
| Move the results set pointer to the next entry (iteration).
GSbool | LadderQuery_GetCurrentEntryField (GSuint uiRequestID, const GSchar *pszField, GSint &iValue)
| Get the current numeric field value.
GSbool | LadderQuery_GetCurrentEntryFieldAsString (GSuint uiRequestID, const GSchar *pszField, GSchar *pszValue)
| Get the current field value in a string format.
GSvoid | LadderQuery_ReleaseResult (GSuint uiRequestID)
| Release the results set from memory.
GSbool | LadderQueryFix_RequestReply (CBLadderQueryRcv_RequestReply fQueryReply)
| Set the function name for the callback.
GSRESULT | RemoteAlgorithm_Initialise (const GSchar *szGameName)
| Initialises the resources required by the service.
GSRESULT | RemoteAlgorithm_Uninitialise ()
| Releases the resources acquired by the service.
GSRESULT | RemoteAlgorithm_Engine (GSuint uiMaxPostingDelay=500, GSuint uiMaxOperationalDelay=800)
| Runs the service.
GSRESULT | RemoteAlgorithm_Execute (GSuint uiAlgoId, const RAE_VALUE *pInput, GSuint uiNumInput, const RemoteAlgorithm_OutputCB fOutput, const GSvoid *pData, GSuint &uiRequestId)
| Requests the execution of an algorithm.

## Detailed Description

Description:
  This file provide all the methods that allow developers to use the basic ubi.com services.

## Function Documentation

GSbool GSClientLibrary_Initialize | ( |  | ) |

  | Description: Initialize the communication ressources. Must be call prior to any other functions. Returns: Status of the function call Return values:
  GS_TRUE | Initialisation was successfull
  GS_FALSE | Initialisation failed

GSbool GSClientLibrary_Uninitialize | ( |  | ) |

  | Description: 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. Returns: Status of the function call Return values:
  GS_TRUE | Library deallocation was successfull
  GS_FALSE | Library deallocation failed

GSbool GSGetLocalIPAddress | ( | GSchar * | szIPAddress | ) |

  | Description: 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. Returns: Status of the function call Return values:
  GS_TRUE | IP address detection successfull
  GS_FALSE | IP address detection failed
  Parameters:
  szIPAddress | Character string that contains the ip address

Ubi.com GameService SDK - ©UbiSoft Entertainment 2002
GameService development team