SDK API Reference

Full C API Reference for the Epic Online Services SDK.

Classes

Name

Description

Public struct

EOS_Achievements_AddNotifyAchievementsUnlockedOptions

Input parameters for the EOS_Achievements_AddNotifyAchievementsUnlocked Function.

Public struct

EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByAchievementId Function.

Public struct

EOS_Achievements_CopyAchievementDefinitionByIndexOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex Function.

Public struct

EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId Function.

Public struct

EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex Function.

Public struct

EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyUnlockedAchievementByAchievementId Function.

Public struct

EOS_Achievements_CopyUnlockedAchievementByIndexOptions

Input parameters for the EOS_Achievements_CopyUnlockedAchievementByIndex Function.

Public struct

EOS_Achievements_Definition

Contains information about a single achievement definition with localized text.

Public struct

EOS_Achievements_DefinitionV2

Contains information about a single achievement definition with localized text.

Public struct

EOS_Achievements_GetAchievementDefinitionCountOptions

Input parameters for the EOS_Achievements_GetAchievementDefinitionCount Function.

Public struct

EOS_Achievements_GetUnlockedAchievementCountOptions

Input parameters for the EOS_Achievements_GetUnlockedAchievementCount Function.

Public struct

EOS_Achievements_OnAchievementsUnlockedCallbackInfo

Output parameters for the EOS_Achievements_OnAchievementsUnlockedCallback Function.

Public struct

EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo

Data containing the result information for a query definitions request.

Public struct

EOS_Achievements_PlayerStatInfo

Contains information about a collection of stat info data.

Public struct

EOS_Achievements_QueryDefinitionsOptions

Input parameters for the EOS_Achievements_QueryDefinitions Function.

Public struct

EOS_Achievements_QueryPlayerAchievementsOptions

Input parameters for the EOS_Achievements_QueryPlayerAchievements Function.

Public struct

EOS_Achievements_StatThresholds

Contains information about a collection of stat threshold data.

Public struct

EOS_Achievements_UnlockedAchievement

Contains information about a single unlocked achievement.

Public struct

EOS_Auth_AddNotifyLoginStatusChangedOptions

Input parameters for the AddNotifyLoginStatusChanged Function.

Public struct

EOS_Auth_CopyUserAuthTokenOptions

Input parameters for the EOS_Auth_CopyUserAuthToken Function.

Public struct

EOS_Auth_Credentials

A structure that contains login credentials.

Public struct

EOS_Auth_DeletePersistentAuthCallbackInfo

Output parameters for the EOS_Auth_DeletePersistentAuth Function.

Public struct

EOS_Auth_DeletePersistentAuthOptions

Input parameters for the EOS_Auth_DeletePersistentAuth Function.

Public struct

EOS_Auth_LoginCallbackInfo

Output parameters for the EOS_Auth_Login Function.

Public struct

EOS_Auth_LoginOptions

Input parameters for the EOS_Auth_Login Function.

Public struct

EOS_Auth_LoginStatusChangedCallbackInfo

Output parameters for the EOS_Auth_OnLoginStatusChangedCallback Function.

Public struct

EOS_Auth_LogoutCallbackInfo

Output parameters for the EOS_Auth_Logout Function.

Public struct

EOS_Auth_LogoutOptions

Input parameters for the EOS_Auth_Logout Function.

Public struct

EOS_Auth_PinGrantInfo

Intermediate data needed to complete the EOS_LCT_DeviceCode login flow, returned by EOS_Auth_LoginCallbackInfo.

Public struct

EOS_Auth_Token

A structure that contains an auth token.

Public struct

EOS_Auth_VerifyUserAuthCallbackInfo

Output parameters for the EOS_Auth_VerifyUserAuth Function.

Public struct

EOS_Auth_VerifyUserAuthOptions

Input parameters for the EOS_Auth_VerifyUserAuth Function.

Public struct

EOS_Ecom_CatalogItem

Contains information about a single item within the catalog.

Public struct

EOS_Ecom_CatalogOffer

Contains information about a single offer within the catalog.

Public struct

EOS_Ecom_CatalogRelease

Contains information about a single release within the catalog.

Public struct

EOS_Ecom_CheckoutCallbackInfo

Output parameters for the EOS_Ecom_Checkout Function.

Public struct

EOS_Ecom_CheckoutEntry

Contains information about a request to purchase a single offer.

Public struct

EOS_Ecom_CheckoutOptions

Input parameters for the EOS_Ecom_Checkout Function.

Public struct

EOS_Ecom_CopyEntitlementByIdOptions

Input parameters for the EOS_Ecom_CopyEntitlementById Function.

Public struct

EOS_Ecom_CopyEntitlementByIndexOptions

Input parameters for the EOS_Ecom_CopyEntitlementByIndex Function.

Public struct

EOS_Ecom_CopyEntitlementByNameAndIndexOptions

Input parameters for the EOS_Ecom_CopyEntitlementByNameAndIndex Function.

Public struct

EOS_Ecom_CopyItemByIdOptions

Input parameters for the EOS_Ecom_CopyItemById Function.

Public struct

EOS_Ecom_CopyItemImageInfoByIndexOptions

Input parameters for the EOS_Ecom_CopyItemImageInfoByIndex Function.

Public struct

EOS_Ecom_CopyItemReleaseByIndexOptions

Input parameters for the EOS_Ecom_CopyItemReleaseByIndex Function.

Public struct

EOS_Ecom_CopyOfferByIdOptions

Input parameters for the EOS_Ecom_CopyOfferById Function.

Public struct

EOS_Ecom_CopyOfferByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferByIndex Function.

Public struct

EOS_Ecom_CopyOfferImageInfoByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferImageInfoByIndex Function.

Public struct

EOS_Ecom_CopyOfferItemByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferItemByIndex Function.

Public struct

EOS_Ecom_CopyTransactionByIdOptions

Input parameters for the EOS_Ecom_CopyTransactionById Function.

Public struct

EOS_Ecom_CopyTransactionByIndexOptions

Input parameters for the EOS_Ecom_CopyTransactionByIndex Function.

Public struct

EOS_Ecom_Entitlement

Contains information about a single entitlement associated with an account.

Public struct

EOS_Ecom_GetEntitlementsByNameCountOptions

Input parameters for the EOS_Ecom_GetEntitlementsByNameCount Function.

Public struct

EOS_Ecom_GetEntitlementsCountOptions

Input parameters for the EOS_Ecom_GetEntitlementsCount Function.

Public struct

EOS_Ecom_GetItemImageInfoCountOptions

Input parameters for the EOS_Ecom_GetItemImageInfoCount Function.

Public struct

EOS_Ecom_GetItemReleaseCountOptions

Input parameters for the EOS_Ecom_GetItemReleaseCount Function.

Public struct

EOS_Ecom_GetOfferCountOptions

Input parameters for the EOS_Ecom_GetOfferCount Function.

Public struct

EOS_Ecom_GetOfferImageInfoCountOptions

Input parameters for the EOS_Ecom_GetOfferImageInfoCount Function.

Public struct

EOS_Ecom_GetOfferItemCountOptions

Input parameters for the EOS_Ecom_GetOfferItemCount Function.

Public struct

EOS_Ecom_GetTransactionCountOptions

Input parameters for the EOS_Ecom_GetTransactionCount Function.

Public struct

EOS_Ecom_ItemOwnership

Contains information about a single item ownership associated with an account.

Public struct

EOS_Ecom_KeyImageInfo

Contains information about a key image used by the catalog.

Public struct

EOS_Ecom_QueryEntitlementsCallbackInfo

Output parameters for the EOS_Ecom_QueryEntitlements Function.

Public struct

EOS_Ecom_QueryEntitlementsOptions

Input parameters for the EOS_Ecom_QueryEntitlements Function.

Public struct

EOS_Ecom_QueryOffersCallbackInfo

Output parameters for the EOS_Ecom_QueryOffers Function.

Public struct

EOS_Ecom_QueryOffersOptions

Input parameters for the EOS_Ecom_QueryOffers Function.

Public struct

EOS_Ecom_QueryOwnershipCallbackInfo

Output parameters for the EOS_Ecom_QueryOwnership Function.

Public struct

EOS_Ecom_QueryOwnershipOptions

Input parameters for the EOS_Ecom_QueryOwnership Function.

Public struct

EOS_Ecom_QueryOwnershipTokenCallbackInfo

Output parameters for the EOS_Ecom_QueryOwnershipToken Function.

Public struct

EOS_Ecom_QueryOwnershipTokenOptions

Input parameters for the EOS_Ecom_QueryOwnershipToken Function.

Public struct

EOS_Ecom_RedeemEntitlementsCallbackInfo

Output parameters for the EOS_Ecom_RedeemEntitlements Function.

Public struct

EOS_Ecom_RedeemEntitlementsOptions

Input parameters for the EOS_Ecom_RedeemEntitlements Function.

Public struct

EOS_Ecom_Transaction_CopyEntitlementByIndexOptions

Input parameters for the EOS_Ecom_Transaction_CopyEntitlementByIndex Function.

Public struct

EOS_Ecom_Transaction_GetEntitlementsCountOptions

Input parameters for the EOS_Ecom_Transaction_GetEntitlementsCount Function.

Public struct

EOS_Friends_AcceptInviteCallbackInfo

Output parameters for the EOS_Friends_AcceptInvite Function.

Public struct

EOS_Friends_AcceptInviteOptions

Input parameters for the EOS_Friends_AcceptInvite Function.

Public struct

EOS_Friends_AddNotifyFriendsUpdateOptions

Input parameters for the EOS_Friends_AddNotifyFriendsUpdate Function.

Public struct

EOS_Friends_DeleteFriendCallbackInfo

Output parameters for the EOS_Friends_DeleteFriend Function.

Public struct

EOS_Friends_DeleteFriendOptions

Input parameters for the EOS_Friends_DeleteFriend Function.

Public struct

EOS_Friends_GetFriendAtIndexOptions

Input parameters for the EOS_Friends_GetFriendAtIndex Function.

Public struct

EOS_Friends_GetFriendsCountOptions

Input parameters for the EOS_Friends_GetFriendsCount Function.

Public struct

EOS_Friends_GetStatusOptions

Input parameters for the EOS_Friends_GetStatus Function.

Public struct

EOS_Friends_OnFriendsUpdateInfo

Structure containing information about a friend status update.

Public struct

EOS_Friends_QueryFriendsCallbackInfo

Output parameters for the EOS_Friends_QueryFriends Function.

Public struct

EOS_Friends_QueryFriendsOptions

Input parameters for the EOS_Friends_QueryFriends Function.

Public struct

EOS_Friends_RejectInviteCallbackInfo

Output parameters for the EOS_Friends_RejectInvite Function.

Public struct

EOS_Friends_RejectInviteOptions

Input parameters for the EOS_Friends_RejectInvite Function.

Public struct

EOS_Friends_SendInviteCallbackInfo

Output parameters for the EOS_Friends_SendInvite API.

Public struct

EOS_Friends_SendInviteOptions

Input parameters for the EOS_Friends_SendInvite Function.

Public struct

EOS_IdentityProvider_Options

A specific identity providers options used with EOS_Platform_Options.

Public struct

EOS_IdentityProvider_Steam

The specific option type for Steam to be used with EOS_IdentityProvider_Options.

Public struct

EOS_InitializeOptions

Options for initializing the Epic Online Services SDK.

Public struct

EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByIndex Function.

Public struct

EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId Function.

Public struct

EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByIndex Function.

Public struct

EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByUserId Function.

Public struct

EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByIndex Function.

Public struct

EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByUserId Function.

Public struct

EOS_Leaderboards_Definition

Contains information about a single leaderboard definition

Public struct

EOS_Leaderboards_GetLeaderboardDefinitionCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardDefinitionCount Function.

Public struct

EOS_Leaderboards_GetLeaderboardRecordCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardRecordCount Function.

Public struct

EOS_Leaderboards_GetLeaderboardUserScoreCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardUserScoreCount Function.

Public struct

EOS_Leaderboards_LeaderboardRecord

Contains information about a single leaderboard record

Public struct

EOS_Leaderboards_LeaderboardUserScore

Contains information about a single leaderboard user score

Public struct

EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo

Data containing the result information for a query leaderboard definitions request.

Public struct

EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallbackInfo

Data containing the result information for a query leaderboard ranks request.

Public struct

EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo

Data containing the result information for a query leaderboard user scores request.

Public struct

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardDefinitions Function.

Public struct

EOS_Leaderboards_QueryLeaderboardRanksOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardRanks Function.

Public struct

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores Function.

Public struct

EOS_Leaderboards_UserScoresQueryStatInfo

Contains information about a single stat to query with user scores.

Public struct

EOS_LogMessage

A structure representing a log message

Public struct

EOS_P2P_GetNextReceivedPacketSizeOptions

Structure containing information about who would like to receive a packet.

Public struct

EOS_P2P_SendPacketOptions

Structure containing information about the data being sent and to which player

Public struct

EOS_P2P_SocketId

P2P Socket ID

Public struct

EOS_PageQuery

A page query is part of query options. It is used to allow pagination of query results.

Public struct

EOS_PageResult

A page result is part of query callback info.

Public struct

EOS_Platform_ClientCredentials

Client credentials.

Public struct

EOS_PlayerDataStorage_FileMetadata

Metadata information for a specific file

Public struct

EOS_Presence_DataRecord

An individual presence data record that belongs to a EOS_Presence_Info object.

Public struct

EOS_Presence_Info

All the known presence information for a specific user.

Public struct

EOS_Presence_QueryPresenceCallbackInfo

The result meta-data for a presence query.

Public struct

EOS_Presence_QueryPresenceOptions

Data for the EOS_Presence_QueryPresence function

Public struct

EOS_Stats_CopyStatByIndexOptions

Input parameters for the EOS_Stats_CopyStatByIndex Function.

Public struct

EOS_Stats_CopyStatByNameOptions

Input parameters for the EOS_Stats_CopyStatByName Function.

Public struct

EOS_Stats_GetStatCountOptions

Input parameters for the EOS_Stats_GetStatsCount Function.

Public struct

EOS_Stats_IngestData

Contains information about a single stat to ingest.

Public struct

EOS_Stats_IngestStatCompleteCallbackInfo

Data containing the result information for an ingest stat request.

Public struct

EOS_Stats_IngestStatOptions

Input parameters for the EOS_Stats_IngestStat Function.

Public struct

EOS_Stats_OnQueryStatsCompleteCallbackInfo

Data containing the result information for querying a player's stats request.

Public struct

EOS_Stats_QueryStatsOptions

Input parameters for the EOS_Stats_QueryStats Function.

Public struct

EOS_Stats_Stat

Contains information about a single player stat.

Public struct

EOS_UI_AcknowledgeEventIdOptions

Input parameters for the EOS_UI_AcknowledgeEventId.

Public struct

EOS_UI_GetFriendsVisibleOptions

Input parameters for the EOS_UI_GetFriendsVisible Function.

Public struct

EOS_UI_GetToggleFriendsKeyOptions

Input parameters for the EOS_UI_GetToggleFriendsKey Function.

Public struct

EOS_UI_HideFriendsCallbackInfo

Output parameters for the EOS_UI_HideFriends function.

Public struct

EOS_UI_HideFriendsOptions

Input parameters for the EOS_UI_HideFriends Function.

Public struct

EOS_UI_SetDisplayPreferenceOptions

Input parameters for the EOS_UI_SetDisplayPreference function.

Public struct

EOS_UI_SetToggleFriendsKeyOptions

Input parameters for the EOS_UI_SetToggleFriendsKey Function.

Public struct

EOS_UI_ShowFriendsCallbackInfo

Output parameters for the EOS_UI_ShowFriends function.

Public struct

EOS_UI_ShowFriendsOptions

Input parameters for the EOS_UI_ShowFriends Function.

Public struct

EOS_UserInfo

A structure that contains the user information.

Public struct

EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByAccountId Function.

Public struct

EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByAccountType function.

Public struct

EOS_UserInfo_CopyExternalUserInfoByIndexOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByIndex Function.

Public struct

EOS_UserInfo_CopyUserInfoOptions

Input parameters for the EOS_UserInfo_CopyUserInfo Function.

Public struct

EOS_UserInfo_ExternalUserInfo

Contains information about a single external user info.

Public struct

EOS_UserInfo_GetExternalUserInfoCountOptions

Input parameters for the EOS_UserInfo_GetExternalUserInfoCount Function.

Public struct

EOS_UserInfo_QueryUserInfoByDisplayNameCallbackInfo

Output parameters for the EOS_UserInfo_QueryUserInfoByDisplayName Function.

Public struct

EOS_UserInfo_QueryUserInfoByDisplayNameOptions

Input parameters for the EOS_UserInfo_QueryUserInfoByDisplayName Function.

Public struct

EOS_UserInfo_QueryUserInfoCallbackInfo

Output parameters for the EOS_UserInfo_QueryUserInfo Function.

Public struct

EOS_UserInfo_QueryUserInfoOptions

Input parameters for the EOS_UserInfo_QueryUserInfo Function.

Typedefs

Name

Description

EOS_Achievements_AddNotifyAchievementsUnlockedOptions

Input parameters for the EOS_Achievements_AddNotifyAchievementsUnlocked Function.

EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByAchievementId Function.

EOS_Achievements_CopyAchievementDefinitionByIndexOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex Function.

EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId Function.

EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions

Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex Function.

EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions

Input parameters for the EOS_Achievements_CopyUnlockedAchievementByAchievementId Function.

EOS_Achievements_CopyUnlockedAchievementByIndexOptions

Input parameters for the EOS_Achievements_CopyUnlockedAchievementByIndex Function.

EOS_Achievements_Definition

Contains information about a single achievement definition with localized text.

EOS_Achievements_DefinitionV2

Contains information about a single achievement definition with localized text.

EOS_Achievements_GetAchievementDefinitionCountOptions

Input parameters for the EOS_Achievements_GetAchievementDefinitionCount Function.

EOS_Achievements_GetUnlockedAchievementCountOptions

Input parameters for the EOS_Achievements_GetUnlockedAchievementCount Function.

EOS_Achievements_OnAchievementsUnlockedCallback

Function prototype definition for notifications that come from EOS_Achievements_AddNotifyAchievementsUnlocked

EOS_Achievements_OnAchievementsUnlockedCallbackInfo

Output parameters for the EOS_Achievements_OnAchievementsUnlockedCallback Function.

EOS_Achievements_OnQueryDefinitionsCompleteCallback

Function prototype definition for callbacks passed to EOS_Achievements_QueryDefinitions

EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo

Data containing the result information for a query definitions request.

EOS_Achievements_PlayerStatInfo

Contains information about a collection of stat info data.

EOS_Achievements_QueryDefinitionsOptions

Input parameters for the EOS_Achievements_QueryDefinitions Function.

EOS_Achievements_QueryPlayerAchievementsOptions

Input parameters for the EOS_Achievements_QueryPlayerAchievements Function.

EOS_Achievements_StatThresholds

Contains information about a collection of stat threshold data.

EOS_Achievements_UnlockedAchievement

Contains information about a single unlocked achievement.

EOS_AllocateMemoryFunc

Function prototype type definition for functions that allocate memory.

EOS_Auth_AddNotifyLoginStatusChangedOptions

Input parameters for the AddNotifyLoginStatusChanged Function.

EOS_Auth_CopyUserAuthTokenOptions

Input parameters for the EOS_Auth_CopyUserAuthToken Function.

EOS_Auth_Credentials

A structure that contains login credentials.

EOS_Auth_DeletePersistentAuthCallbackInfo

Output parameters for the EOS_Auth_DeletePersistentAuth Function.

EOS_Auth_DeletePersistentAuthOptions

Input parameters for the EOS_Auth_DeletePersistentAuth Function.

EOS_Auth_LoginCallbackInfo

Output parameters for the EOS_Auth_Login Function.

EOS_Auth_LoginOptions

Input parameters for the EOS_Auth_Login Function.

EOS_Auth_LoginStatusChangedCallbackInfo

Output parameters for the EOS_Auth_OnLoginStatusChangedCallback Function.

EOS_Auth_LogoutCallbackInfo

Output parameters for the EOS_Auth_Logout Function.

EOS_Auth_LogoutOptions

Input parameters for the EOS_Auth_Logout Function.

EOS_Auth_OnDeletePersistentAuthCallback

Function prototype definition for callbacks passed to EOS_Auth_DeletePersistentAuth

EOS_Auth_OnLoginCallback

Function prototype definition for callbacks passed to EOS_Auth_Login

EOS_Auth_OnLoginStatusChangedCallback

Function prototype definition for notifications that come from EOS_Auth_AddNotifyLoginStatusChanged

EOS_Auth_OnLogoutCallback

Function prototype definition for callbacks passed to EOS_Auth_Logout

EOS_Auth_OnVerifyUserAuthCallback

Function prototype definition for callbacks passed to EOS_Auth_VerifyUserAuth

EOS_Auth_PinGrantInfo

Intermediate data needed to complete the EOS_LCT_DeviceCode login flow, returned by EOS_Auth_LoginCallbackInfo.

EOS_Auth_Token

A structure that contains an auth token.

EOS_Auth_VerifyUserAuthCallbackInfo

Output parameters for the EOS_Auth_VerifyUserAuth Function.

EOS_Auth_VerifyUserAuthOptions

Input parameters for the EOS_Auth_VerifyUserAuth Function.

EOS_Bool

EOS_ContinuanceToken

A handle to a continuance token

EOS_EAttributeType

Supported types of data that can be stored with inside an attribute (used by sessions/lobbies/etc)

EOS_EAuthScopeFlags

EOS_EAuthTokenType

Types of auth tokens

EOS_Ecom_CatalogItem

Contains information about a single item within the catalog.

EOS_Ecom_CatalogItemId

A unique identifier for a catalog item defined and stored with the backend catalog service.

EOS_Ecom_CatalogOffer

Contains information about a single offer within the catalog.

EOS_Ecom_CatalogOfferId

A unique identifier for a catalog offer defined and stored with the backend catalog service.

EOS_Ecom_CatalogRelease

Contains information about a single release within the catalog.

EOS_Ecom_CheckoutCallbackInfo

Output parameters for the EOS_Ecom_Checkout Function.

EOS_Ecom_CheckoutEntry

Contains information about a request to purchase a single offer.

EOS_Ecom_CheckoutOptions

Input parameters for the EOS_Ecom_Checkout Function.

EOS_Ecom_CopyEntitlementByIdOptions

Input parameters for the EOS_Ecom_CopyEntitlementById Function.

EOS_Ecom_CopyEntitlementByIndexOptions

Input parameters for the EOS_Ecom_CopyEntitlementByIndex Function.

EOS_Ecom_CopyEntitlementByNameAndIndexOptions

Input parameters for the EOS_Ecom_CopyEntitlementByNameAndIndex Function.

EOS_Ecom_CopyItemByIdOptions

Input parameters for the EOS_Ecom_CopyItemById Function.

EOS_Ecom_CopyItemImageInfoByIndexOptions

Input parameters for the EOS_Ecom_CopyItemImageInfoByIndex Function.

EOS_Ecom_CopyItemReleaseByIndexOptions

Input parameters for the EOS_Ecom_CopyItemReleaseByIndex Function.

EOS_Ecom_CopyOfferByIdOptions

Input parameters for the EOS_Ecom_CopyOfferById Function.

EOS_Ecom_CopyOfferByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferByIndex Function.

EOS_Ecom_CopyOfferImageInfoByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferImageInfoByIndex Function.

EOS_Ecom_CopyOfferItemByIndexOptions

Input parameters for the EOS_Ecom_CopyOfferItemByIndex Function.

EOS_Ecom_CopyTransactionByIdOptions

Input parameters for the EOS_Ecom_CopyTransactionById Function.

EOS_Ecom_CopyTransactionByIndexOptions

Input parameters for the EOS_Ecom_CopyTransactionByIndex Function.

EOS_Ecom_Entitlement

Contains information about a single entitlement associated with an account.

EOS_Ecom_EntitlementId

A unique identifier for an entitlement owned by an account.

EOS_Ecom_EntitlementName

An identifier which is defined on a catalog item and stored with the backend catalog service.

EOS_Ecom_GetEntitlementsByNameCountOptions

Input parameters for the EOS_Ecom_GetEntitlementsByNameCount Function.

EOS_Ecom_GetEntitlementsCountOptions

Input parameters for the EOS_Ecom_GetEntitlementsCount Function.

EOS_Ecom_GetItemImageInfoCountOptions

Input parameters for the EOS_Ecom_GetItemImageInfoCount Function.

EOS_Ecom_GetItemReleaseCountOptions

Input parameters for the EOS_Ecom_GetItemReleaseCount Function.

EOS_Ecom_GetOfferCountOptions

Input parameters for the EOS_Ecom_GetOfferCount Function.

EOS_Ecom_GetOfferImageInfoCountOptions

Input parameters for the EOS_Ecom_GetOfferImageInfoCount Function.

EOS_Ecom_GetOfferItemCountOptions

Input parameters for the EOS_Ecom_GetOfferItemCount Function.

EOS_Ecom_GetTransactionCountOptions

Input parameters for the EOS_Ecom_GetTransactionCount Function.

EOS_Ecom_HTransaction

This handle is copied when EOS_Ecom_CopyTransactionById or EOS_Ecom_CopyTransactionByIndex is called.

EOS_Ecom_ItemOwnership

Contains information about a single item ownership associated with an account.

EOS_Ecom_KeyImageInfo

Contains information about a key image used by the catalog.

EOS_Ecom_OnCheckoutCallback

Function prototype definition for callbacks passed to EOS_Ecom_Checkout

EOS_Ecom_OnQueryEntitlementsCallback

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken

EOS_Ecom_OnQueryOffersCallback

Function prototype definition for callbacks passed to EOS_Ecom_QueryOffers

EOS_Ecom_OnQueryOwnershipCallback

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnership

EOS_Ecom_OnQueryOwnershipTokenCallback

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken

EOS_Ecom_OnRedeemEntitlementsCallback

Function prototype definition for callbacks passed to EOS_Ecom_RedeemEntitlements

EOS_Ecom_QueryEntitlementsCallbackInfo

Output parameters for the EOS_Ecom_QueryEntitlements Function.

EOS_Ecom_QueryEntitlementsOptions

Input parameters for the EOS_Ecom_QueryEntitlements Function.

EOS_Ecom_QueryOffersCallbackInfo

Output parameters for the EOS_Ecom_QueryOffers Function.

EOS_Ecom_QueryOffersOptions

Input parameters for the EOS_Ecom_QueryOffers Function.

EOS_Ecom_QueryOwnershipCallbackInfo

Output parameters for the EOS_Ecom_QueryOwnership Function.

EOS_Ecom_QueryOwnershipOptions

Input parameters for the EOS_Ecom_QueryOwnership Function.

EOS_Ecom_QueryOwnershipTokenCallbackInfo

Output parameters for the EOS_Ecom_QueryOwnershipToken Function.

EOS_Ecom_QueryOwnershipTokenOptions

Input parameters for the EOS_Ecom_QueryOwnershipToken Function.

EOS_Ecom_RedeemEntitlementsCallbackInfo

Output parameters for the EOS_Ecom_RedeemEntitlements Function.

EOS_Ecom_RedeemEntitlementsOptions

Input parameters for the EOS_Ecom_RedeemEntitlements Function.

EOS_Ecom_Transaction_CopyEntitlementByIndexOptions

Input parameters for the EOS_Ecom_Transaction_CopyEntitlementByIndex Function.

EOS_Ecom_Transaction_GetEntitlementsCountOptions

Input parameters for the EOS_Ecom_Transaction_GetEntitlementsCount Function.

EOS_EComparisonOp

All comparison operators associated with parameters in a search query

EOS_EEcomItemType

An enumeration defining the type of catalog item.

EOS_EExternalAccountType

All supported external account providers

EOS_EFriendsStatus

An enumeration of the different friendship statuses.

EOS_EIdentityProviderFlags

Identity Provider initialization flags used by specific Identity Provider options.

EOS_EIdentityProviderType

This enumeration is used to distinguish between different supported additional identity providers.

EOS_ELeaderboardAggregation

An enumeration of the different leaderboard aggregation types.

EOS_ELobbyAttributeType

EOS_ELogCategory

Logging Categories

EOS_ELoginCredentialType

All possible types of login methods, availability depends on permissions granted to the client

EOS_ELoginStatus

All possible states of a local user

EOS_ELogLevel

Logging levels.

EOS_EMetricsAccountIdType

Account ID type for EOS_Metrics_BeginPlayerSession and EOS_Metrics_EndPlayerSession.

EOS_ENATType

Categories of NAT strictness.

EOS_EOnlineComparisonOp

EOS_EOwnershipStatus

An enumeration of the different ownership statuses.

EOS_EpicAccountId

A handle to a user's Epic account ID This id is associated with a specific login associated with Epic Account Services

EOS_EResult

EOS_ESessionAttributeType

EOS_EUserControllerType

User game controller types.

EOS_Friends_AcceptInviteCallbackInfo

Output parameters for the EOS_Friends_AcceptInvite Function.

EOS_Friends_AcceptInviteOptions

Input parameters for the EOS_Friends_AcceptInvite Function.

EOS_Friends_AddNotifyFriendsUpdateOptions

Input parameters for the EOS_Friends_AddNotifyFriendsUpdate Function.

EOS_Friends_DeleteFriendCallbackInfo

Output parameters for the EOS_Friends_DeleteFriend Function.

EOS_Friends_DeleteFriendOptions

Input parameters for the EOS_Friends_DeleteFriend Function.

EOS_Friends_GetFriendAtIndexOptions

Input parameters for the EOS_Friends_GetFriendAtIndex Function.

EOS_Friends_GetFriendsCountOptions

Input parameters for the EOS_Friends_GetFriendsCount Function.

EOS_Friends_GetStatusOptions

Input parameters for the EOS_Friends_GetStatus Function.

EOS_Friends_OnAcceptInviteCallback

Function prototype definition for callbacks passed to EOS_Friends_AcceptInvite

EOS_Friends_OnDeleteFriendCallback

Function prototype definition for callbacks passed to EOS_Friends_DeleteFriend

EOS_Friends_OnFriendsUpdateCallback

Callback for information related to a friend status update.

EOS_Friends_OnFriendsUpdateInfo

Structure containing information about a friend status update.

EOS_Friends_OnQueryFriendsCallback

Function prototype definition for callbacks passed to EOS_Friends_QueryFriends

EOS_Friends_OnRejectInviteCallback

Function prototype definition for callbacks passed to EOS_Friends_RejectInvite

EOS_Friends_OnSendInviteCallback

Function prototype definition for callbacks passed to EOS_Friends_SendInvite

EOS_Friends_QueryFriendsCallbackInfo

Output parameters for the EOS_Friends_QueryFriends Function.

EOS_Friends_QueryFriendsOptions

Input parameters for the EOS_Friends_QueryFriends Function.

EOS_Friends_RejectInviteCallbackInfo

Output parameters for the EOS_Friends_RejectInvite Function.

EOS_Friends_RejectInviteOptions

Input parameters for the EOS_Friends_RejectInvite Function.

EOS_Friends_SendInviteCallbackInfo

Output parameters for the EOS_Friends_SendInvite API.

EOS_Friends_SendInviteOptions

Input parameters for the EOS_Friends_SendInvite Function.

EOS_HAchievements

EOS_HActiveSession

Handle to a single named session that exists locally

EOS_HAuth

EOS_HConnect

EOS_HEcom

EOS_HFriends

EOS_HLeaderboards

EOS_HLobby

Handle to the lobby interface

EOS_HLobbyDetails

Handle to a single lobby

EOS_HLobbyModification

Handle to a lobby modification object

EOS_HLobbySearch

Handle to the calls responsible for creating a search object

EOS_HMetrics

EOS_HP2P

EOS_HPlatform

EOS_HPlayerDataStorage

EOS_HPresence

EOS_HPresenceModification

EOS_HSessionDetails

Handle to a single session that may be part of a named session, search result, or invite

EOS_HSessionModification

Handle to the calls responsible for creating/updating sessions

EOS_HSessions

Handle to the sessions interface

EOS_HSessionSearch

Handle to the calls responsible for creating a search object

EOS_HStats

EOS_HUI

Handle to the UI interface

EOS_HUserInfo

EOS_IdentityProvider_Options

A specific identity providers options used with EOS_Platform_Options.

EOS_IdentityProvider_Steam

The specific option type for Steam to be used with EOS_IdentityProvider_Options.

EOS_InitializeOptions

Options for initializing the Epic Online Services SDK.

EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByIndex Function.

EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId Function.

EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByIndex Function.

EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByUserId Function.

EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByIndex Function.

EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions

Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByUserId Function.

EOS_Leaderboards_Definition

Contains information about a single leaderboard definition

EOS_Leaderboards_GetLeaderboardDefinitionCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardDefinitionCount Function.

EOS_Leaderboards_GetLeaderboardRecordCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardRecordCount Function.

EOS_Leaderboards_GetLeaderboardUserScoreCountOptions

Input parameters for the EOS_Leaderboards_GetLeaderboardUserScoreCount Function.

EOS_Leaderboards_LeaderboardRecord

Contains information about a single leaderboard record

EOS_Leaderboards_LeaderboardUserScore

Contains information about a single leaderboard user score

EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback

Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardDefinitions

EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo

Data containing the result information for a query leaderboard definitions request.

EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback

Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardRanks

EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallbackInfo

Data containing the result information for a query leaderboard ranks request.

EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback

Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardUserScores

EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo

Data containing the result information for a query leaderboard user scores request.

EOS_Leaderboards_QueryLeaderboardDefinitionsOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardDefinitions Function.

EOS_Leaderboards_QueryLeaderboardRanksOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardRanks Function.

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores Function.

EOS_Leaderboards_UserScoresQueryStatInfo

Contains information about a single stat to query with user scores.

EOS_LobbyId

All lobbies are referenced by a unique lobby id

EOS_LogMessage

A structure representing a log message

EOS_LogMessageFunc

Function prototype definition for functions that receive log messages.

EOS_NotificationId

Handle to an existing registered notification (0 is an invalid handle)

EOS_P2P_SendPacketOptions

Structure containing information about the data being sent and to which player

EOS_P2P_SocketId

P2P Socket ID

EOS_PageQuery

A page query is part of query options. It is used to allow pagination of query results.

EOS_PageResult

A page result is part of query callback info.

EOS_Platform_ClientCredentials

Client credentials.

EOS_Presence_DataRecord

An individual presence data record that belongs to a EOS_Presence_Info object.

EOS_Presence_EStatus

Presence Status states of a user

EOS_Presence_Info

All the known presence information for a specific user.

EOS_Presence_OnQueryPresenceCompleteCallback

Callback for information related to EOS_Presence_QueryPresence finishing.

EOS_Presence_QueryPresenceCallbackInfo

The result meta-data for a presence query.

EOS_Presence_QueryPresenceOptions

Data for the EOS_Presence_QueryPresence function

EOS_ProductUserId

A handle to a user's product user id (game services related ecosystem) This id is associated with any of the external account providers (of which Epic Account Services is one)

EOS_ReallocateMemoryFunc

Function prototype type definition for functions that reallocate memory.

EOS_ReleaseMemoryFunc

Function prototype type definition for functions that release memory.

EOS_Stats_CopyStatByIndexOptions

Input parameters for the EOS_Stats_CopyStatByIndex Function.

EOS_Stats_CopyStatByNameOptions

Input parameters for the EOS_Stats_CopyStatByName Function.

EOS_Stats_GetStatCountOptions

Input parameters for the EOS_Stats_GetStatsCount Function.

EOS_Stats_IngestData

Contains information about a single stat to ingest.

EOS_Stats_IngestStatCompleteCallbackInfo

Data containing the result information for an ingest stat request.

EOS_Stats_IngestStatOptions

Input parameters for the EOS_Stats_IngestStat Function.

EOS_Stats_OnIngestStatCompleteCallback

Function prototype definition for callbacks passed to EOS_Stats_IngestStat

EOS_Stats_OnQueryStatsCompleteCallback

Function prototype definition for callbacks passed to EOS_Stats_QueryStats

EOS_Stats_OnQueryStatsCompleteCallbackInfo

Data containing the result information for querying a player's stats request.

EOS_Stats_QueryStatsOptions

Input parameters for the EOS_Stats_QueryStats Function.

EOS_Stats_Stat

Contains information about a single player stat.

EOS_UI_AcknowledgeEventIdOptions

Input parameters for the EOS_UI_AcknowledgeEventId.

EOS_UI_EKeyCombination

EOS_UI_ENotificationLocation

Notification locations to be used to set the preference for pop-up.

EOS_UI_EventId

ID representing a specific UI event.

EOS_UI_GetFriendsVisibleOptions

Input parameters for the EOS_UI_GetFriendsVisible Function.

EOS_UI_GetToggleFriendsKeyOptions

Input parameters for the EOS_UI_GetToggleFriendsKey Function.

EOS_UI_HideFriendsCallbackInfo

Output parameters for the EOS_UI_HideFriends function.

EOS_UI_HideFriendsOptions

Input parameters for the EOS_UI_HideFriends Function.

EOS_UI_OnHideFriendsCallback

Function prototype definition for callbacks passed to EOS_UI_HideFriends

EOS_UI_OnShowFriendsCallback

Function prototype definition for callbacks passed to EOS_UI_ShowFriends

EOS_UI_SetDisplayPreferenceOptions

Input parameters for the EOS_UI_SetDisplayPreference function.

EOS_UI_SetToggleFriendsKeyOptions

Input parameters for the EOS_UI_SetToggleFriendsKey Function.

EOS_UI_ShowFriendsCallbackInfo

Output parameters for the EOS_UI_ShowFriends function.

EOS_UI_ShowFriendsOptions

Input parameters for the EOS_UI_ShowFriends Function.

EOS_UserInfo

A structure that contains the user information.

EOS_UserInfo_CopyExternalUserInfoByAccountIdOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByAccountId Function.

EOS_UserInfo_CopyExternalUserInfoByAccountTypeOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByAccountType function.

EOS_UserInfo_CopyExternalUserInfoByIndexOptions

Input parameters for the EOS_UserInfo_CopyExternalUserInfoByIndex Function.

EOS_UserInfo_CopyUserInfoOptions

Input parameters for the EOS_UserInfo_CopyUserInfo Function.

EOS_UserInfo_ExternalUserInfo

Contains information about a single external user info.

EOS_UserInfo_GetExternalUserInfoCountOptions

Input parameters for the EOS_UserInfo_GetExternalUserInfoCount Function.

EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback

Function prototype definition for callbacks passed to EOS_UserInfo_QueryUserInfo

EOS_UserInfo_OnQueryUserInfoCallback

Function prototype definition for callbacks passed to EOS_UserInfo_QueryUserInfo

EOS_UserInfo_QueryUserInfoByDisplayNameCallbackInfo

Output parameters for the EOS_UserInfo_QueryUserInfoByDisplayName Function.

EOS_UserInfo_QueryUserInfoByDisplayNameOptions

Input parameters for the EOS_UserInfo_QueryUserInfoByDisplayName Function.

EOS_UserInfo_QueryUserInfoCallbackInfo

Output parameters for the EOS_UserInfo_QueryUserInfo Function.

EOS_UserInfo_QueryUserInfoOptions

Input parameters for the EOS_UserInfo_QueryUserInfo Function.

Enums

Name

Description

Public enum

EOS_EAttributeType

Supported types of data that can be stored with inside an attribute (used by sessions/lobbies/etc)

Public enum

EOS_EAuthScopeFlags

Public enum

EOS_EAuthTokenType

Types of auth tokens

Public enum

EOS_EComparisonOp

All comparison operators associated with parameters in a search query

Public enum

EOS_EEcomItemType

An enumeration defining the type of catalog item.

Public enum

EOS_EExternalAccountType

All supported external account providers

Public enum

EOS_EExternalCredentialType

List of the supported identity providers to authenticate a user.

Public enum

EOS_EFriendsStatus

An enumeration of the different friendship statuses.

Public enum

EOS_EIdentityProviderFlags

Identity Provider initialization flags used by specific Identity Provider options.

Public enum

EOS_EIdentityProviderType

This enumeration is used to distinguish between different supported additional identity providers.

Public enum

EOS_ELeaderboardAggregation

An enumeration of the different leaderboard aggregation types.

Public enum

EOS_ELobbyPermissionLevel

Permission level gets more restrictive further down

Public enum

EOS_ELogCategory

Logging Categories

Public enum

EOS_ELoginCredentialType

All possible types of login methods, availability depends on permissions granted to the client

Public enum

EOS_ELoginStatus

All possible states of a local user

Public enum

EOS_ELogLevel

Logging levels.

Public enum

EOS_EMetricsAccountIdType

Account ID type for EOS_Metrics_BeginPlayerSession and EOS_Metrics_EndPlayerSession.

Public enum

EOS_ENATType

Categories of NAT strictness.

Public enum

EOS_EOnlineSessionState

All possible states of an existing named session

Public enum

EOS_EOwnershipStatus

An enumeration of the different ownership statuses.

Public enum

EOS_EResult

Public enum

EOS_EUserControllerType

User game controller types.

Public enum

EOS_Presence_EStatus

Presence Status states of a user

Public enum

EOS_UI_EKeyCombination

Public enum

EOS_UI_ENotificationLocation

Notification locations to be used to set the preference for pop-up.

Functions

Name Description

Public function

EOS_NotificationId

 

EOS_Achievements_AddNotifyAchievementsUnlocked

(
    EOS_HAchievements Handle,
    const EOS_Achievements_AddNotifyAch ...,
    void* ClientData,
    const EOS_Achievements_OnAchievemen ...
)

DEPRECATED! Use EOS_Achievements_AddNotifyAchievementsUnlockedV2 instead.

Public function

EOS_NotificationId

 

EOS_Achievements_AddNotifyAchievementsUnlockedV2

(
    EOS_HAchievements Handle,
    const EOS_Achievements_AddNotifyAch...,
    void* ClientData,
    const EOS_Achievements_OnAchievemen...
)

Register to receive achievement unlocked notifications.

Public function

EOS_EResult

 

EOS_Achievements_CopyAchievementDefinitionByAchievementId

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyAchievem ...,
    EOS_Achievements_Definition *&#...
)

DEPRECATED! Use EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId instead.

Public function

EOS_EResult

 

EOS_Achievements_CopyAchievementDefinitionByIndex

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyAchievem ...,
    EOS_Achievements_Definition *&#...
)

DEPRECATED! Use EOS_Achievements_CopyAchievementDefinitionV2ByIndex instead.

Public function

EOS_EResult

 

EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyAchievem ...,
    EOS_Achievements_DefinitionV2 *...
)

Fetches an achievement definition from a given achievement ID.

Public function

EOS_EResult

 

EOS_Achievements_CopyAchievementDefinitionV2ByIndex

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyAchievem ...,
    EOS_Achievements_DefinitionV2 *...
)

Fetches an achievement definition from a given index.

Public function

EOS_EResult

 

EOS_Achievements_CopyPlayerAchievementByAchievementId

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyPlayerAc...,
    EOS_Achievements_PlayerAchievement ...
)

Fetches a player achievement from a given achievement id.

Public function

EOS_EResult

 

EOS_Achievements_CopyPlayerAchievementByIndex

(
    EOS_HAchievements Handle,
    const EOS_Achievements_CopyPlayerAc...,
    EOS_Achievements_PlayerAchievement ...
)

Fetches a player achievement from a given index.

Public function

EOS_EResult

 

EOS_Achievements_CopyUnlockedAchievementByAchievementId

DEPRECATED! Use EOS_Achievements_CopyPlayerAchievementByAchievementId instead.

Public function

EOS_EResult

 

EOS_Achievements_CopyUnlockedAchievementByIndex

DEPRECATED! Use EOS_Achievements_CopyPlayerAchievementByAchievementId instead.

Public function

void

 

EOS_Achievements_Definition_Release

(
    EOS_Achievements_Definition * A...
)

Release the memory associated with achievement definitions.

Public function

void

 

EOS_Achievements_DefinitionV2_Release

Release the memory associated with EOS_Achievements_DefinitionV2.

Public function

uint32_t

 

EOS_Achievements_GetAchievementDefinitionCount

(
    EOS_HAchievements Handle,
    const EOS_Achievements_GetAchieveme ...
)

Fetch the number of achievement definitions that are cached locally.

Public function

uint32_t

 

EOS_Achievements_GetPlayerAchievementCount

(
    EOS_HAchievements Handle,
    const EOS_Achievements_GetPlayerAch...
)

Fetch the number of player achievements that are cached locally.

Public function

uint32_t

 

EOS_Achievements_GetUnlockedAchievementCount

(
    EOS_HAchievements Handle,
    const EOS_Achievements_GetUnlockedA ...
)

DEPRECATED! Use EOS_Achievements_GetPlayerAchievementCount, EOS_Achievements_CopyPlayerAchievementByIndex and filter for unlocked instead.

Public function

void

 

EOS_Achievements_QueryDefinitions

(
    EOS_HAchievements Handle,
    const EOS_Achievements_QueryDefinit ...,
    void* ClientData,
    const EOS_Achievements_OnQueryDefin ...
)

The following EOS_Achievements_* functions allow you to query existing achievement definitions that have been defined for your application.

Public function

void

 

EOS_Achievements_QueryPlayerAchievements

(
    EOS_HAchievements Handle,
    const EOS_Achievements_QueryPlayerA ...,
    void* ClientData,
    const EOS_Achievements_OnQueryPlaye...
)

Query for a list of achievements for a specific player, including progress towards completion for each achievement.

Public function

void

 

EOS_Achievements_RemoveNotifyAchievementsUnlocked

(
    EOS_HAchievements Handle,
    EOS_NotificationId InId
)

Unregister from receiving achievement unlocked notifications.

Public function

void

 

EOS_Achievements_UnlockAchievements

(
    EOS_HAchievements Handle,
    const EOS_Achievements_UnlockAchiev...,
    void* ClientData,
    const EOS_Achievements_OnUnlockAchi...
)

Unlocks a number of achievements for a specific player.

Public function

void

 

EOS_Achievements_UnlockedAchievement_Release

Release the memory associated with an unlocked achievement.

Public function

EOS_EResult

 

EOS_ActiveSession_CopyInfo

(
    EOS_HActiveSession Handle,
    const EOS_ActiveSession_CopyInfoOpt...,
    EOS_ActiveSession_Info** O...
)

Representation of an existing session some local players are actively involved in (via Create/Join) EOS_ActiveSession_CopyInfo is used to immediately retrieve a copy of active session information If the call returns an EOS_Success result, the out parameter, OutActiveSessionInfo, must be passed to EOS_ActiveSession_Info_Release to release the memory associated with it.

Public function

EOS_ProductUserId

 

EOS_ActiveSession_GetRegisteredPlayerByIndex

(
    EOS_HActiveSession Handle,
    const EOS_ActiveSession_GetRegister...
)

EOS_ActiveSession_GetRegisteredPlayerByIndex is used to immediately retrieve individual players registered with the active session.

Public function

uint32_t

 

EOS_ActiveSession_GetRegisteredPlayerCount

(
    EOS_HActiveSession Handle,
    const EOS_ActiveSession_GetRegister...
)

Get the number of registered players associated with this active session

Public function

void

 

EOS_ActiveSession_Release

(
    EOS_HActiveSession ActiveSessionHan...
)

Release the memory associated with an active session.

Public function

EOS_NotificationId

 

EOS_Auth_AddNotifyLoginStatusChanged

(
    EOS_HAuth Handle,
    const EOS_Auth_AddNotifyLoginStatus ...,
    void* ClientData,
    const EOS_Auth_OnLoginStatusChanged ...
)

Register to receive login status updates.

Public function

EOS_EResult

 

EOS_Auth_CopyUserAuthToken

(
    EOS_HAuth Handle,
    const EOS_Auth_CopyUserAuthTokenOpt ...,
    EOS_EpicAccountId LocalUserId,
    EOS_Auth_Token ** OutUserAu...
)

Fetches a user auth token for an account id.

Public function

void

 

EOS_Auth_DeletePersistentAuth

(
    EOS_HAuth Handle,
    const EOS_Auth_DeletePersistentAuth ...,
    void* ClientData,
    const EOS_Auth_OnDeletePersistentAu ...
)

Deletes a previously received and locally stored persistent auth access token for the currently logged in user of the local device.

Public function

EOS_EpicAccountId

 

EOS_Auth_GetLoggedInAccountByIndex

(
    EOS_HAuth Handle,
    int32_t Index
)

Fetch an account id that is logged in.

Public function

int32_t

 

EOS_Auth_GetLoggedInAccountsCount

(
    EOS_HAuth Handle
)

Fetch the number of accounts that are logged in.

Public function

EOS_ELoginStatus

 

EOS_Auth_GetLoginStatus

(
    EOS_HAuth Handle,
    EOS_EpicAccountId LocalUserId
)

Fetches the login status for an account id.

Public function

void

 

EOS_Auth_Login

(
    EOS_HAuth Handle,
    const EOS_Auth_LoginOptions * O...,
    void* ClientData,
    const EOS_Auth_OnLoginCallback Comp...
)

The Auth Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials.

Public function

void

 

EOS_Auth_Logout

(
    EOS_HAuth Handle,
    const EOS_Auth_LogoutOptions * ...,
    void* ClientData,
    const EOS_Auth_OnLogoutCallback Com...
)

Signs the player out of the online service.

Public function

void

 

EOS_Auth_RemoveNotifyLoginStatusChanged

(
    EOS_HAuth Handle,
    EOS_NotificationId InId
)

Unregister from receiving login status updates.

Public function

void

 

EOS_Auth_Token_Release

(
    EOS_Auth_Token * AuthToken
)

Release the memory associated with an EOS_Auth_Token structure.

Public function

void

 

EOS_Auth_VerifyUserAuth

(
    EOS_HAuth Handle,
    const EOS_Auth_VerifyUserAuthOption ...,
    void* ClientData,
    const EOS_Auth_OnVerifyUserAuthCall ...
)

Contact the backend service to verify validity of an existing user auth token.

Public function

EOS_EResult

 

EOS_ByteArray_ToString

(
    const uint8_t* ByteArray,
    const uint32_t Length,
    char* OutBuffer,
    uint32_t* InOutBufferLength
)

Encode a byte array into hex encoded string

Public function

EOS_NotificationId

 

EOS_Connect_AddNotifyAuthExpiration

(
    EOS_HConnect Handle,
    const EOS_Connect_AddNotifyAuthExpi...,
    void* ClientData,
    const EOS_Connect_OnAuthExpirationC...
)

Register to receive upcoming authentication expiration notifications.

Public function

EOS_NotificationId

 

EOS_Connect_AddNotifyLoginStatusChanged

(
    EOS_HConnect Handle,
    const EOS_Connect_AddNotifyLoginSta...,
    void* ClientData,
    const EOS_Connect_OnLoginStatusChan...
)

Register to receive user login status updates.

Public function

EOS_EResult

 

EOS_Connect_CopyProductUserExternalAccountByAccountId

(
    EOS_HConnect Handle,
    const EOS_Connect_CopyProductUserEx...,
    EOS_Connect_ExternalAccountInfo...
)

Fetch information about an external account linked to a product user id.

Public function

EOS_EResult

 

EOS_Connect_CopyProductUserExternalAccountByAccountType

(
    EOS_HConnect Handle,
    const EOS_Connect_CopyProductUserEx...,
    EOS_Connect_ExternalAccountInfo...
)

Fetch information about an external account of a specific type linked to a product user id.

Public function

EOS_EResult

 

EOS_Connect_CopyProductUserExternalAccountByIndex

(
    EOS_HConnect Handle,
    const EOS_Connect_CopyProductUserEx...,
    EOS_Connect_ExternalAccountInfo...
)

Fetch information about an external account linked to a product user id.

Public function

EOS_EResult

 

EOS_Connect_CopyProductUserInfo

(
    EOS_HConnect Handle,
    const EOS_Connect_CopyProductUserIn...,
    EOS_Connect_ExternalAccountInfo...
)

Fetch information about a Product User, using the external account that they most recently logged in with as the reference.

Public function

void

 

EOS_Connect_CreateDeviceId

(
    EOS_HConnect Handle,
    const EOS_Connect_CreateDeviceIdOpt...,
    void* ClientData,
    const EOS_Connect_OnCreateDeviceIdC...
)

Create a new unique pseudo-account that can be used to identify the current user profile on the local device.

Public function

void

 

EOS_Connect_CreateUser

(
    EOS_HConnect Handle,
    const EOS_Connect_CreateUserOptions...,
    void* ClientData,
    const EOS_Connect_OnCreateUserCallb...
)

Create an account association with the Epic Online Service as a product user given their external auth credentials

Public function

void

 

EOS_Connect_DeleteDeviceId

(
    EOS_HConnect Handle,
    const EOS_Connect_DeleteDeviceIdOpt...,
    void* ClientData,
    const EOS_Connect_OnDeleteDeviceIdC...
)

Delete any existing Device ID access credentials for the current user profile on the local device.

Public function

EOS_ProductUserId

 

EOS_Connect_GetExternalAccountMapping

(
    EOS_HConnect Handle,
    const EOS_Connect_GetExternalAccoun...
)

Fetch a product user id that maps to an external account id

Public function

EOS_ProductUserId

 

EOS_Connect_GetLoggedInUserByIndex

(
    EOS_HConnect Handle,
    int32_t Index
)

Fetch a product user id that is logged in.

Public function

int32_t

 

EOS_Connect_GetLoggedInUsersCount

(
    EOS_HConnect Handle
)

Fetch the number of product users that are logged in.

Public function

EOS_ELoginStatus

 

EOS_Connect_GetLoginStatus

(
    EOS_HConnect Handle,
    EOS_ProductUserId LocalUserId
)

Fetches the login status for an product user id.

Public function

uint32_t

 

EOS_Connect_GetProductUserExternalAccountCount

(
    EOS_HConnect Handle,
    const EOS_Connect_GetProductUserExt...
)

Fetch the number of linked external accounts for a product user id.

Public function

EOS_EResult

 

EOS_Connect_GetProductUserIdMapping

(
    EOS_HConnect Handle,
    const EOS_Connect_GetProductUserIdM...,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Fetch an external account id, in string form, that maps to a given product user id

Public function

void

 

EOS_Connect_LinkAccount

(
    EOS_HConnect Handle,
    const EOS_Connect_LinkAccountOption...,
    void* ClientData,
    const EOS_Connect_OnLinkAccountCall...
)

Link a set of external auth credentials with an existing product user on the Epic Online Service

Public function

void

 

EOS_Connect_Login

(
    EOS_HConnect Handle,
    const EOS_Connect_LoginOptions*...,
    void* ClientData,
    const EOS_Connect_OnLoginCallback C...
)

The Connect Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials.

Public function

void

 

EOS_Connect_QueryExternalAccountMappings

(
    EOS_HConnect Handle,
    const EOS_Connect_QueryExternalAcco...,
    void* ClientData,
    const EOS_Connect_OnQueryExternalAc...
)

Retrieve the equivalent product user ids from a list of external account ids from supported account providers.

Public function

void

 

EOS_Connect_QueryProductUserIdMappings

(
    EOS_HConnect Handle,
    const EOS_Connect_QueryProductUserI...,
    void* ClientData,
    const EOS_Connect_OnQueryProductUse...
)

Retrieve the equivalent external account mappings from a list of product user ids.

Public function

void

 

EOS_Connect_RemoveNotifyAuthExpiration

(
    EOS_HConnect Handle,
    EOS_NotificationId InId
)

Unregister from receiving expiration notifications.

Public function

void

 

EOS_Connect_RemoveNotifyLoginStatusChanged

(
    EOS_HConnect Handle,
    EOS_NotificationId InId
)

Unregister from receiving user login status updates.

Public function

void

 

EOS_Ecom_CatalogItem_Release

(
    EOS_Ecom_CatalogItem * CatalogI...
)

Release the memory associated with an EOS_Ecom_CatalogItem structure.

Public function

void

 

EOS_Ecom_CatalogOffer_Release

(
    EOS_Ecom_CatalogOffer * Catalog...
)

Release the memory associated with an EOS_Ecom_CatalogOffer structure.

Public function

void

 

EOS_Ecom_CatalogRelease_Release

(
    EOS_Ecom_CatalogRelease * Catal...
)

Release the memory associated with an EOS_Ecom_CatalogRelease structure.

Public function

void

 

EOS_Ecom_Checkout

(
    EOS_HEcom Handle,
    const EOS_Ecom_CheckoutOptions *...,
    void* ClientData,
    const EOS_Ecom_OnCheckoutCallback C...
)

Initiates the purchase flow for a set of offers.

Public function

EOS_EResult

 

EOS_Ecom_CopyEntitlementById

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyEntitlementByIdO ...,
    EOS_Ecom_Entitlement ** Out...
)

Fetches the entitlement with the given id.

Public function

EOS_EResult

 

EOS_Ecom_CopyEntitlementByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyEntitlementByInd ...,
    EOS_Ecom_Entitlement ** Out...
)

Fetches an entitlement from a given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyEntitlementByNameAndIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyEntitlementByNam ...,
    EOS_Ecom_Entitlement ** Out...
)

Fetches a single entitlement with a given Entitlement Name.

Public function

EOS_EResult

 

EOS_Ecom_CopyItemById

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyItemByIdOptions ...,
    EOS_Ecom_CatalogItem ** Out...
)

Fetches an item with a given ID.

Public function

EOS_EResult

 

EOS_Ecom_CopyItemImageInfoByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyItemImageInfoByI ...,
    EOS_Ecom_KeyImageInfo ** Ou...
)

Fetches an image from a given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyItemReleaseByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyItemReleaseByInd ...,
    EOS_Ecom_CatalogRelease ** ...
)

Fetches a release from a given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyOfferById

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyOfferByIdOptions ...,
    EOS_Ecom_CatalogOffer ** Ou...
)

Fetches an offer with a given ID. The pricing and text are localized to the provided account.

Public function

EOS_EResult

 

EOS_Ecom_CopyOfferByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyOfferByIndexOpti ...,
    EOS_Ecom_CatalogOffer ** Ou...
)

Fetches an offer from a given index. The pricing and text are localized to the provided account.

Public function

EOS_EResult

 

EOS_Ecom_CopyOfferImageInfoByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyOfferImageInfoBy ...,
    EOS_Ecom_KeyImageInfo ** Ou...
)

Fetches an image from a given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyOfferItemByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyOfferItemByIndex ...,
    EOS_Ecom_CatalogItem ** Out...
)

Fetches an item from a given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyTransactionById

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyTransactionByIdO ...,
    EOS_Ecom_HTransaction * OutTran...
)

Fetches the transaction handle at the given index.

Public function

EOS_EResult

 

EOS_Ecom_CopyTransactionByIndex

(
    EOS_HEcom Handle,
    const EOS_Ecom_CopyTransactionByInd ...,
    EOS_Ecom_HTransaction * OutTran...
)

Fetches the transaction handle at the given index.

Public function

void

 

EOS_Ecom_Entitlement_Release

(
    EOS_Ecom_Entitlement * Entitlem...
)

Release the memory associated with an EOS_Ecom_Entitlement structure.

Public function

uint32_t

 

EOS_Ecom_GetEntitlementsByNameCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetEntitlementsByNam ...
)

Fetch the number of entitlements with the given Entitlement Name that are cached for a given local user.

Public function

uint32_t

 

EOS_Ecom_GetEntitlementsCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetEntitlementsCount ...
)

Fetch the number of entitlements that are cached for a given local user.

Public function

uint32_t

 

EOS_Ecom_GetItemImageInfoCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetItemImageInfoCoun ...
)

Fetch the number of images that are associated with a given cached item for a local user.

Public function

uint32_t

 

EOS_Ecom_GetItemReleaseCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetItemReleaseCountO ...
)

Fetch the number of releases that are associated with a given cached item for a local user.

Public function

uint32_t

 

EOS_Ecom_GetOfferCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetOfferCountOptions ...
)

Fetch the number of offers that are cached for a given local user.

Public function

uint32_t

 

EOS_Ecom_GetOfferImageInfoCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetOfferImageInfoCou ...
)

Fetch the number of images that are associated with a given cached offer for a local user.

Public function

uint32_t

 

EOS_Ecom_GetOfferItemCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetOfferItemCountOpt ...
)

Fetch the number of items that are associated with a given cached offer for a local user.

Public function

uint32_t

 

EOS_Ecom_GetTransactionCount

(
    EOS_HEcom Handle,
    const EOS_Ecom_GetTransactionCountO ...
)

Fetch the number of transactions that are cached for a given local user.

Public function

void

 

EOS_Ecom_KeyImageInfo_Release

(
    EOS_Ecom_KeyImageInfo * KeyImag...
)

Release the memory associated with an EOS_Ecom_KeyImageInfo structure.

Public function

void

 

EOS_Ecom_QueryEntitlements

(
    EOS_HEcom Handle,
    const EOS_Ecom_QueryEntitlementsOpt ...,
    void* ClientData,
    const EOS_Ecom_OnQueryEntitlementsC ...
)

Query the entitlement information defined with Epic Online Services.

Public function

void

 

EOS_Ecom_QueryOffers

(
    EOS_HEcom Handle,
    const EOS_Ecom_QueryOffersOptions &...,
    void* ClientData,
    const EOS_Ecom_OnQueryOffersCallbac ...
)

Query for a list of catalog offers defined with Epic Online Services.

Public function

void

 

EOS_Ecom_QueryOwnership

(
    EOS_HEcom Handle,
    const EOS_Ecom_QueryOwnershipOption ...,
    void* ClientData,
    const EOS_Ecom_OnQueryOwnershipCall ...
)

The Ecom Interface exposes all catalog, purchasing, and ownership entitlement features available with the Epic Games store All Ecom Interface calls take a handle of type EOS_HEcom as the first parameter.

Public function

void

 

EOS_Ecom_QueryOwnershipToken

(
    EOS_HEcom Handle,
    const EOS_Ecom_QueryOwnershipTokenO ...,
    void* ClientData,
    const EOS_Ecom_OnQueryOwnershipToke ...
)

Query the ownership status for a given list of catalog item ids defined with Epic Online Services.

Public function

void

 

EOS_Ecom_RedeemEntitlements

(
    EOS_HEcom Handle,
    const EOS_Ecom_RedeemEntitlementsOp ...,
    void* ClientData,
    const EOS_Ecom_OnRedeemEntitlements ...
)

Requests that the provided entitlement be marked redeemed.

Public function

EOS_EResult

 

EOS_Ecom_Transaction_CopyEntitlementByIndex

(
    EOS_Ecom_HTransaction Handle,
    const EOS_Ecom_Transaction_CopyEnti ...,
    EOS_Ecom_Entitlement ** Out...
)

Fetches an entitlement from a given index.

Public function

uint32_t

 

EOS_Ecom_Transaction_GetEntitlementsCount

(
    EOS_Ecom_HTransaction Handle,
    const EOS_Ecom_Transaction_GetEntit ...
)

Fetch the number of entitlements that are part of this transaction.

Public function

EOS_EResult

 

EOS_Ecom_Transaction_GetTransactionId

(
    EOS_Ecom_HTransaction Handle,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

The Ecom Transaction Interface exposes getters for accessing information about a completed transaction.

Public function

void

 

EOS_Ecom_Transaction_Release

(
    EOS_Ecom_HTransaction Transaction
)

Release the memory associated with an EOS_Ecom_HTransaction.

Public function

EOS_EpicAccountId

 

EOS_EpicAccountId_FromString

(
    const char* AccountIdString
)

Retrieve an EOS_EpicAccountId from a raw account ID string.

Public function

EOS_Bool

 

EOS_EpicAccountId_IsValid

(
    EOS_EpicAccountId AccountId
)

Check whether or not the given account unique id is considered valid

Public function

EOS_EResult

 

EOS_EpicAccountId_ToString

(
    EOS_EpicAccountId AccountId,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Retrieve a string-ified account ID from an EOS_EpicAccountId.

Public function

EOS_Bool

 

EOS_EResult_IsOperationComplete

(
    EOS_EResult Result
)

Returns whether a result is to be considered the final result, or false if the callback that returned this result will be called again either after some time or from another action.

Public function

const char *

 

EOS_EResult_ToString

(
    EOS_EResult Result
)

Returns a string representation of an EOS_EResult.

Public function

void

 

EOS_Friends_AcceptInvite

(
    EOS_HFriends Handle,
    const EOS_Friends_AcceptInviteOptio ...,
    void* ClientData,
    const EOS_Friends_OnAcceptInviteCal ...
)

Starts an asynchronous task that accepts a friend invitation from another user.

Public function

EOS_NotificationId

 

EOS_Friends_AddNotifyFriendsUpdate

(
    EOS_HFriends Handle,
    const EOS_Friends_AddNotifyFriendsU ...,
    void* ClientData,
    const EOS_Friends_OnFriendsUpdateCa ...
)

Listen for changes to friends for a particular account.

Public function

EOS_EpicAccountId

 

EOS_Friends_GetFriendAtIndex

(
    EOS_HFriends Handle,
    const EOS_Friends_GetFriendAtIndexO ...
)

Retrieves the account id of an entry from the friends list that has already been retrieved by the EOS_Friends_QueryFriends API.

Public function

int32_t

 

EOS_Friends_GetFriendsCount

(
    EOS_HFriends Handle,
    const EOS_Friends_GetFriendsCountOp ...
)

Retrieves the number of friends on the friends list that has already been retrieved by the EOS_Friends_QueryFriends API.

Public function

EOS_EFriendsStatus

 

EOS_Friends_GetStatus

(
    EOS_HFriends Handle,
    const EOS_Friends_GetStatusOptions ...
)

Retrieve the friendship status between the local user and another user.

Public function

void

 

EOS_Friends_QueryFriends

(
    EOS_HFriends Handle,
    const EOS_Friends_QueryFriendsOptio ...,
    void* ClientData,
    const EOS_Friends_OnQueryFriendsCal ...
)

The Friends Interface is used to manage a user's friends list, by interacting with the backend services, and to retrieve the cached list of friends and pending invitations.

Public function

void

 

EOS_Friends_RejectInvite

(
    EOS_HFriends Handle,
    const EOS_Friends_RejectInviteOptio ...,
    void* ClientData,
    const EOS_Friends_OnRejectInviteCal ...
)

Starts an asynchronous task that rejects a friend invitation from another user.

Public function

void

 

EOS_Friends_RemoveNotifyFriendsUpdate

(
    EOS_HFriends Handle,
    EOS_NotificationId NotificationId
)

Stop listening for friends changes on a previously bound handler.

Public function

void

 

EOS_Friends_SendInvite

(
    EOS_HFriends Handle,
    const EOS_Friends_SendInviteOptions ...,
    void* ClientData,
    const EOS_Friends_OnSendInviteCallb ...
)

Starts an asynchronous task that sends a friend invitation to another user.

Public function

const char *

 

EOS_GetVersion()

Get the version of the EOSSDK binary

Public function

EOS_EResult

 

EOS_Initialize

(
    const EOS_InitializeOptions * O...
)

Initialize the Epic Online Services SDK.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardDefinitionByIndex

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_CopyLeaderbo ...,
    EOS_Leaderboards_Definition *&#...
)

Fetches a leaderboard definition from the cache using an index.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_CopyLeaderbo ...,
    EOS_Leaderboards_Definition *&#...
)

Fetches a leaderboard definition from the cache using a leaderboard ID.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardRecordByIndex

Fetches a leaderboard record from a given index.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardRecordByUserId

Fetches a leaderboard record from a given user ID.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardUserScoreByIndex

Fetches leaderboard user score from a given index.

Public function

EOS_EResult

 

EOS_Leaderboards_CopyLeaderboardUserScoreByUserId

Fetches leaderboard user score from a given user ID.

Public function

void

 

EOS_Leaderboards_Definition_Release

(
    EOS_Leaderboards_Definition * L...
)

Release the memory associated with a leaderboard definition.

Public function

uint32_t

 

EOS_Leaderboards_GetLeaderboardDefinitionCount

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_GetLeaderboa ...
)

Fetch the number of leaderboards definitions that are cached locally.

Public function

uint32_t

 

EOS_Leaderboards_GetLeaderboardRecordCount

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_GetLeaderboa ...
)

Fetch the number of leaderboard records that are cached locally.

Public function

uint32_t

 

EOS_Leaderboards_GetLeaderboardUserScoreCount

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_GetLeaderboa ...
)

Fetch the number of leaderboard user scores that are cached locally.

Public function

void

 

EOS_Leaderboards_LeaderboardDefinition_Release

(
    EOS_Leaderboards_Definition * L...
)

Public function

void

 

EOS_Leaderboards_LeaderboardRecord_Release

Release the memory associated with leaderboard record.

Public function

void

 

EOS_Leaderboards_LeaderboardUserScore_Release

Release the memory associated with leaderboard user score.

Public function

void

 

EOS_Leaderboards_QueryLeaderboardDefinitions

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_QueryLeaderb ...,
    void* ClientData,
    const EOS_Leaderboards_OnQueryLeade ...
)

The following EOS_Leaderboards_* functions allow you to query existing leaderboard definitions that have been defined for your application.

Public function

void

 

EOS_Leaderboards_QueryLeaderboardRanks

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_QueryLeaderb ...,
    void* ClientData,
    const EOS_Leaderboards_OnQueryLeade ...
)

Retrieves top leaderboard records by rank in the leaderboard matching the given leaderboard ID.

Public function

void

 

EOS_Leaderboards_QueryLeaderboardUserScores

(
    EOS_HLeaderboards Handle,
    const EOS_Leaderboards_QueryLeaderb ...,
    void* ClientData,
    const EOS_Leaderboards_OnQueryLeade ...
)

Query for a list of scores for a given list of users.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyJoinLobbyAccepted

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyJoinLobbyA...,
    void* ClientData,
    const EOS_Lobby_OnJoinLobbyAccepted...
)

Register to receive notifications about lobby join game accepted by local user via the overlay.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyLobbyInviteAccepted

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyLobbyInvit...,
    void* ClientData,
    const EOS_Lobby_OnLobbyInviteAccept...
)

Register to receive notifications about lobby invites accepted by local user via the overlay.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyLobbyInviteReceived

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyLobbyInvit...,
    void* ClientData,
    const EOS_Lobby_OnLobbyInviteReceiv...
)

Register to receive notifications about lobby invites sent to local users.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyLobbyMemberStatusReceived

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyLobbyMembe...,
    void* ClientData,
    const EOS_Lobby_OnLobbyMemberStatus...
)

Register to receive notifications about the changing status of lobby members.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyLobbyMemberUpdateReceived

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyLobbyMembe...,
    void* ClientData,
    const EOS_Lobby_OnLobbyMemberUpdate...
)

Register to receive notifications when a lobby member updates the attributes associated with themselves inside the lobby.

Public function

EOS_NotificationId

 

EOS_Lobby_AddNotifyLobbyUpdateReceived

(
    EOS_HLobby Handle,
    const EOS_Lobby_AddNotifyLobbyUpdat...,
    void* ClientData,
    const EOS_Lobby_OnLobbyUpdateReceiv...
)

Register to receive notifications when a lobby owner updates the attributes associated with the lobby.

Public function

EOS_EResult

 

EOS_Lobby_CopyLobbyDetailsHandle

(
    EOS_HLobby Handle,
    const EOS_Lobby_CopyLobbyDetailsHan...,
    EOS_HLobbyDetails * OutLobbyDet...
)

Create a handle to an existing lobby.

Public function

EOS_EResult

 

EOS_Lobby_CopyLobbyDetailsHandleByInviteId

(
    EOS_HLobby Handle,
    const EOS_Lobby_CopyLobbyDetailsHan...,
    EOS_HLobbyDetails * OutLobbyDet...
)

EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Public function

EOS_EResult

 

EOS_Lobby_CopyLobbyDetailsHandleByUiEventId

(
    EOS_HLobby Handle,
    const EOS_Lobby_CopyLobbyDetailsHan...,
    EOS_HLobbyDetails * OutLobbyDet...
)

EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of an join game If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Public function

void

 

EOS_Lobby_CreateLobby

(
    EOS_HLobby Handle,
    const EOS_Lobby_CreateLobbyOptions ...,
    void* ClientData,
    const EOS_Lobby_OnCreateLobbyCallba...
)

The Lobby Interface is used to manage lobbies that provide a persistent connection between users and notifications of data sharing/updates.

Public function

EOS_EResult

 

EOS_Lobby_CreateLobbySearch

(
    EOS_HLobby Handle,
    const EOS_Lobby_CreateLobbySearchOp...,
    EOS_HLobbySearch * OutLobbySear...
)

Create a lobby search handle.

Public function

void

 

EOS_Lobby_DestroyLobby

(
    EOS_HLobby Handle,
    const EOS_Lobby_DestroyLobbyOptions...,
    void* ClientData,
    const EOS_Lobby_OnDestroyLobbyCallb...
)

Destroy a lobby given a lobby id

Public function

uint32_t

 

EOS_Lobby_GetInviteCount

(
    EOS_HLobby Handle,
    const EOS_Lobby_GetInviteCountOptio...
)

Get the number of known invites for a given user

Public function

EOS_EResult

 

EOS_Lobby_GetInviteIdByIndex

(
    EOS_HLobby Handle,
    const EOS_Lobby_GetInviteIdByIndexO...,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Retrieve an invite id from a list of active invites for a given user

Public function

void

 

EOS_Lobby_JoinLobby

(
    EOS_HLobby Handle,
    const EOS_Lobby_JoinLobbyOptions&#...,
    void* ClientData,
    const EOS_Lobby_OnJoinLobbyCallback...
)

Join a lobby, creating a local instance under a given lobby id.

Public function

void

 

EOS_Lobby_KickMember

(
    EOS_HLobby Handle,
    const EOS_Lobby_KickMemberOptions&...,
    void* ClientData,
    const EOS_Lobby_OnKickMemberCallbac...
)

Kick an existing member from the lobby

Public function

void

 

EOS_Lobby_LeaveLobby

(
    EOS_HLobby Handle,
    const EOS_Lobby_LeaveLobbyOptions&...,
    void* ClientData,
    const EOS_Lobby_OnLeaveLobbyCallbac...
)

Leave a lobby given a lobby id

Public function

void

 

EOS_Lobby_PromoteMember

(
    EOS_HLobby Handle,
    const EOS_Lobby_PromoteMemberOption...,
    void* ClientData,
    const EOS_Lobby_OnPromoteMemberCall...
)

Promote an existing member of the lobby to owner, allowing them to make lobby data modifications

Public function

void

 

EOS_Lobby_QueryInvites

(
    EOS_HLobby Handle,
    const EOS_Lobby_QueryInvitesOptions...,
    void* ClientData,
    const EOS_Lobby_OnQueryInvitesCallb...
)

Retrieve all existing invites for a single user

Public function

void

 

EOS_Lobby_RejectInvite

(
    EOS_HLobby Handle,
    const EOS_Lobby_RejectInviteOptions...,
    void* ClientData,
    const EOS_Lobby_OnRejectInviteCallb...
)

Reject an invite from another user.

Public function

void

 

EOS_Lobby_RemoveNotifyJoinLobbyAccepted

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.

Public function

void

 

EOS_Lobby_RemoveNotifyLobbyInviteAccepted

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.

Public function

void

 

EOS_Lobby_RemoveNotifyLobbyInviteReceived

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user receives a lobby invitation.

Public function

void

 

EOS_Lobby_RemoveNotifyLobbyMemberStatusReceived

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when lobby members status change.

Public function

void

 

EOS_Lobby_RemoveNotifyLobbyMemberUpdateReceived

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when lobby members change their data.

Public function

void

 

EOS_Lobby_RemoveNotifyLobbyUpdateReceived

(
    EOS_HLobby Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a lobby changes its data.

Public function

void

 

EOS_Lobby_SendInvite

(
    EOS_HLobby Handle,
    const EOS_Lobby_SendInviteOptions&...,
    void* ClientData,
    const EOS_Lobby_OnSendInviteCallbac...
)

Send an invite to another user. User must be a member of the lobby or else the call will fail

Public function

void

 

EOS_Lobby_UpdateLobby

(
    EOS_HLobby Handle,
    const EOS_Lobby_UpdateLobbyOptions ...,
    void* ClientData,
    const EOS_Lobby_OnUpdateLobbyCallba...
)

Update a lobby given a lobby modification handle created via EOS_Lobby_UpdateLobbyModification

Public function

EOS_EResult

 

EOS_Lobby_UpdateLobbyModification

(
    EOS_HLobby Handle,
    const EOS_Lobby_UpdateLobbyModifica...,
    EOS_HLobbyModification * OutLob...
)

Creates a lobby modification handle (EOS_HLobbyModification).

Public function

EOS_EResult

 

EOS_LobbyDetails_CopyAttributeByIndex

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_CopyAttribut...,
    EOS_Lobby_Attribute** OutA...
)

EOS_LobbyDetails_CopyAttributeByIndex is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.

Public function

EOS_EResult

 

EOS_LobbyDetails_CopyAttributeByKey

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_CopyAttribut...,
    EOS_Lobby_Attribute** OutA...
)

EOS_LobbyDetails_CopyAttributeByKey is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.

Public function

EOS_EResult

 

EOS_LobbyDetails_CopyInfo

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_CopyInfoOpti...,
    EOS_LobbyDetails_Info** Ou...
)

EOS_LobbyDetails_CopyInfo is used to immediately retrieve a copy of lobby information from a given source such as a existing lobby or a search result.

Public function

EOS_EResult

 

EOS_LobbyDetails_CopyMemberAttributeByIndex

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_CopyMemberAt...,
    EOS_Lobby_Attribute** OutA...
)

EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.

Public function

EOS_EResult

 

EOS_LobbyDetails_CopyMemberAttributeByKey

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_CopyMemberAt...,
    EOS_Lobby_Attribute** OutA...
)

EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.

Public function

uint32_t

 

EOS_LobbyDetails_GetAttributeCount

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_GetAttribute...
)

Get the number of attributes associated with this lobby

Public function

EOS_ProductUserId

 

EOS_LobbyDetails_GetLobbyOwner

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_GetLobbyOwne...
)

A "read only" representation of an existing lobby that games interact with externally.

Public function

uint32_t

 

EOS_LobbyDetails_GetMemberAttributeCount

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_GetMemberAtt...
)

EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.

Public function

EOS_ProductUserId

 

EOS_LobbyDetails_GetMemberByIndex

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_GetMemberByI...
)

EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.

Public function

uint32_t

 

EOS_LobbyDetails_GetMemberCount

(
    EOS_HLobbyDetails Handle,
    const EOS_LobbyDetails_GetMemberCou...
)

Get the number of members associated with this lobby

Public function

void

 

EOS_LobbyDetails_Release

(
    EOS_HLobbyDetails LobbyHandle
)

Release the memory associated with a single lobby.

Public function

EOS_EResult

 

EOS_LobbyModification_AddAttribute

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_AddAttr...
)

Associate an attribute with this lobby An attribute is something may be public or private with the lobby.

Public function

EOS_EResult

 

EOS_LobbyModification_AddMemberAttribute

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_AddMemb...
)

Associate an attribute with a member of the lobby Lobby member data is always private to the lobby

Public function

void

 

EOS_LobbyModification_Release

(
    EOS_HLobbyModification LobbyModific...
)

Public function

EOS_EResult

 

EOS_LobbyModification_RemoveAttribute

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_RemoveA...
)

Remove an attribute associated with the lobby

Public function

EOS_EResult

 

EOS_LobbyModification_RemoveMemberAttribute

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_RemoveM...
)

Remove an attribute associated with of member of the lobby

Public function

EOS_EResult

 

EOS_LobbyModification_SetMaxMembers

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_SetMaxM...
)

Set the maximum number of members allowed in this lobby.

Public function

EOS_EResult

 

EOS_LobbyModification_SetPermissionLevel

(
    EOS_HLobbyModification Handle,
    const EOS_LobbyModification_SetPerm...
)

To modify lobbies or the lobby member data, you must call EOS_Lobby_UpdateLobbyModification to create a Lobby Modification handle.

Public function

EOS_EResult

 

EOS_LobbySearch_CopySearchResultByIndex

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_CopySearchRes...,
    EOS_HLobbyDetails * OutLobbyDet...
)

EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result.

Public function

void

 

EOS_LobbySearch_Find

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_FindOptions&...,
    void* ClientData,
    const EOS_LobbySearch_OnFindCallbac...
)

Class responsible for the creation, setup, and execution of a search query.

Public function

uint32_t

 

EOS_LobbySearch_GetSearchResultCount

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_GetSearchResu...
)

Get the number of search results found by the search parameters in this search

Public function

void

 

EOS_LobbySearch_Release

(
    EOS_HLobbySearch LobbySearchHandle
)

Release the memory associated with a lobby search.

Public function

EOS_EResult

 

EOS_LobbySearch_RemoveParameter

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_RemoveParamet...
)

Remove a parameter from the array of search criteria.

Public function

EOS_EResult

 

EOS_LobbySearch_SetLobbyId

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_SetLobbyIdOpt...
)

Set a lobby id to find and will return at most one search result.

Public function

EOS_EResult

 

EOS_LobbySearch_SetMaxResults

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_SetMaxResults...
)

Set the maximum number of search results to return in the query, can't be more than EOS_LOBBY_MAX_SEARCH_RESULTS

Public function

EOS_EResult

 

EOS_LobbySearch_SetParameter

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_SetParameterO...
)

Add a parameter to an array of search criteria combined via an implicit AND operator.

Public function

EOS_EResult

 

EOS_LobbySearch_SetTargetUserId

(
    EOS_HLobbySearch Handle,
    const EOS_LobbySearch_SetTargetUser...
)

Set a target user id to find.

Public function

EOS_EResult

 

EOS_Logging_SetCallback

(
    EOS_LogMessageFunc Callback
)

Set the callback function to use for SDK log messages.

Public function

EOS_EResult

 

EOS_Logging_SetLogLevel

(
    EOS_ELogCategory LogCategory,
    EOS_ELogLevel LogLevel
)

Set the logging level for the specified logging category.

Public function

EOS_EResult

 

EOS_Metrics_BeginPlayerSession

(
    EOS_HMetrics Handle,
    const EOS_Metrics_BeginPlayerSessio...
)

Logs the start of a new game session for a local player.

Public function

EOS_EResult

 

EOS_Metrics_EndPlayerSession

(
    EOS_HMetrics Handle,
    const EOS_Metrics_EndPlayerSessionO...
)

Logs the end of a game session for a local player.

Public function

EOS_EResult

 

EOS_P2P_AcceptConnection

(
    EOS_HP2P Handle,
    const EOS_P2P_AcceptConnectionOptio...
)

Accept connections from a specific peer.

Public function

EOS_NotificationId

 

EOS_P2P_AddNotifyPeerConnectionClosed

(
    EOS_HP2P Handle,
    const EOS_P2P_AddNotifyPeerConnecti...,
    void* ClientData,
    EOS_P2P_OnRemoteConnectionClosedCal...
)

Listen for when a previously opened connection is closed

Public function

EOS_NotificationId

 

EOS_P2P_AddNotifyPeerConnectionRequest

(
    EOS_HP2P Handle,
    const EOS_P2P_AddNotifyPeerConnecti...,
    void* ClientData,
    EOS_P2P_OnIncomingConnectionRequest...
)

Listen for incoming connection requests on a particular Socket ID, or optionally all Socket IDs.

Public function

EOS_EResult

 

EOS_P2P_CloseConnection

(
    EOS_HP2P Handle,
    const EOS_P2P_CloseConnectionOption...
)

Stop accepting new connections from a specific peer and close any open connections.

Public function

EOS_EResult

 

EOS_P2P_CloseConnections

(
    EOS_HP2P Handle,
    const EOS_P2P_CloseConnectionsOptio...
)

Close any open Connections for a specific Peer Connection ID.

Public function

EOS_EResult

 

EOS_P2P_GetNATType

(
    EOS_HP2P Handle,
    const EOS_P2P_GetNATTypeOptions...,
    EOS_ENATType * OutNATType
)

Get our last-queried NAT-type, if it has been successfully queried.

Public function

EOS_EResult

 

EOS_P2P_GetNextReceivedPacketSize

(
    EOS_HP2P Handle,
    const EOS_P2P_GetNextReceivedPacket...,
    uint32_t* OutPacketSizeBytes
)

Gets the size of the packet that will be returned by ReceivePacket for a particular user, if there is any available packets to be retrieved.

Public function

void

 

EOS_P2P_QueryNATType

(
    EOS_HP2P Handle,
    const EOS_P2P_QueryNATTypeOptions&...,
    void* ClientData,
    const EOS_P2P_OnQueryNATTypeComplet...
)

Query the current NAT-type of our connection.

Public function

EOS_EResult

 

EOS_P2P_ReceivePacket

(
    EOS_HP2P Handle,
    const EOS_P2P_ReceivePacketOptions ...,
    EOS_ProductUserId * OutPeerId,
    EOS_P2P_SocketId * OutSocketId,
    uint8_t* OutChannel,
    void* OutData,
    uint32_t* OutBytesWritten
)

Receive the next packet for the local user, and information associated with this packet, if it exists.

Public function

void

 

EOS_P2P_RemoveNotifyPeerConnectionClosed

(
    EOS_HP2P Handle,
    EOS_NotificationId NotificationId
)

Stop notifications for connections being closed on a previously bound handler

Public function

void

 

EOS_P2P_RemoveNotifyPeerConnectionRequest

(
    EOS_HP2P Handle,
    EOS_NotificationId NotificationId
)

Stop listening for connection requests on a previously bound handler

Public function

EOS_EResult

 

EOS_P2P_SendPacket

(
    EOS_HP2P Handle,
    const EOS_P2P_SendPacketOptions ...
)

P2P functions to help manage sending and receiving of messages to peers

Public function

EOS_EResult

 

EOS_Platform_CheckForLauncherAndRestart

(
    EOS_HPlatform Handle
)

Checks if the app was launched through the Epic Launcher, and relaunches it through the Epic Launcher if it wasn't.

Public function

EOS_HPlatform

 

EOS_Platform_Create

(
    const EOS_Platform_Options* Op...
)

Create a single Epic Online Services Platform Instance.

Public function

EOS_HAchievements

 

EOS_Platform_GetAchievementsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Achievements Interface.

Public function

EOS_EResult

 

EOS_Platform_GetActiveCountryCode

(
    EOS_HPlatform Handle,
    EOS_EpicAccountId LocalUserId,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

This only will return the value set as the override otherwise EOS_NotFound is returned.

Public function

EOS_EResult

 

EOS_Platform_GetActiveLocaleCode

(
    EOS_HPlatform Handle,
    EOS_EpicAccountId LocalUserId,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Get the active locale code that the SDK will send to services which require it.

Public function

EOS_HAuth

 

EOS_Platform_GetAuthInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Auth Interface.

Public function

EOS_HConnect

 

EOS_Platform_GetConnectInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Connect Interface.

Public function

EOS_HEcom

 

EOS_Platform_GetEcomInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Ecom Interface.

Public function

EOS_HFriends

 

EOS_Platform_GetFriendsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Friends Interface.

Public function

EOS_HLeaderboards

 

EOS_Platform_GetLeaderboardsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Leaderboards Interface.

Public function

EOS_HLobby

 

EOS_Platform_GetLobbyInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Lobby Interface.

Public function

EOS_HMetrics

 

EOS_Platform_GetMetricsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Metrics Interface.

Public function

EOS_EResult

 

EOS_Platform_GetOverrideCountryCode

(
    EOS_HPlatform Handle,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Get the override country code that the SDK will send to services which require it.

Public function

EOS_EResult

 

EOS_Platform_GetOverrideLocaleCode

(
    EOS_HPlatform Handle,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Get the override locale code that the SDK will send to services which require it.

Public function

EOS_HP2P

 

EOS_Platform_GetP2PInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Peer-to-Peer Networking Interface.

Public function

EOS_HPlayerDataStorage

 

EOS_Platform_GetPlayerDataStorageInterface

(
    EOS_HPlatform Handle
)

Get a handle to the PlayerDataStorage Interface.

Public function

EOS_HPresence

 

EOS_Platform_GetPresenceInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Presence Interface.

Public function

EOS_HSessions

 

EOS_Platform_GetSessionsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Sessions Interface.

Public function

EOS_HStats

 

EOS_Platform_GetStatsInterface

(
    EOS_HPlatform Handle
)

Get a handle to the Stats Interface.

Public function

EOS_HUI

 

EOS_Platform_GetUIInterface

(
    EOS_HPlatform Handle
)

Get a handle to the UI Interface.

Public function

EOS_HUserInfo

 

EOS_Platform_GetUserInfoInterface

(
    EOS_HPlatform Handle
)

Get a handle to the UserInfo Interface.

Public function

void

 

EOS_Platform_Release

(
    EOS_HPlatform Handle
)

Release an Epic Online Services platform instance previously returned from EOS_Platform_Create.

Public function

EOS_EResult

 

EOS_Platform_SetOverrideCountryCode

(
    EOS_HPlatform Handle,
    const char* NewCountryCode
)

Set the override country code that the SDK will send to services which require it.

Public function

EOS_EResult

 

EOS_Platform_SetOverrideLocaleCode

(
    EOS_HPlatform Handle,
    const char* NewLocaleCode
)

Set the override locale code that the SDK will send to services which require it.

Public function

void

 

EOS_Platform_Tick

(
    EOS_HPlatform Handle
)

The Platform Instance is used to gain access to all other Epic Online Service interfaces and to drive internal operations through the Tick.

Public function

EOS_EResult

 

EOS_PlayerDataStorage_CopyFileMetadataAtIndex

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_CopyFil...,
    EOS_PlayerDataStorage_FileMetadata ...
)

Get the cached copy of a file's metadata by index.

Public function

EOS_EResult

 

EOS_PlayerDataStorage_CopyFileMetadataByFilename

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_CopyFil...,
    EOS_PlayerDataStorage_FileMetadata ...
)

Create the cached copy of a file's metadata by filename.

Public function

void

 

EOS_PlayerDataStorage_DeleteFile

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_DeleteF...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnDelet...
)

Deletes an existing file in the cloud.

Public function

void

 

EOS_PlayerDataStorage_DuplicateFile

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_Duplica...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnDupli...
)

Copies the data of an existing file to a new filename.

Public function

EOS_EResult

 

EOS_PlayerDataStorage_GetFileMetadataCount

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_GetFile...,
    int32_t* OutFileMetadataCount
)

Get the count of files we have previously queried information for and files we have previously read from / written to.

Public function

void

 

EOS_PlayerDataStorage_QueryFile

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_QueryFi...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnQuery...
)

The following EOS_PlayerDataStorage_* functions allow you to query file metadata; create/upload files; and duplicate, read, and delete existing files Query a specific file's metadata, such as file names, size, and a MD5 hash of the data.

Public function

void

 

EOS_PlayerDataStorage_QueryFileList

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_QueryFi...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnQuery...
)

Query the file metadata, such as file names, size, and a MD5 hash of the data, for all files owned by this user for this application.

Public function

EOS_HPlayerDataStorageFileTransferRequest

 

EOS_PlayerDataStorage_ReadFile

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_ReadFil...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnReadF...
)

Retrieve the contents of a specific file, potentially downloading the contents if we do not have a local copy, from the cloud.

Public function

EOS_HPlayerDataStorageFileTransferRequest

 

EOS_PlayerDataStorage_WriteFile

(
    EOS_HPlayerDataStorage Handle,
    const EOS_PlayerDataStorage_WriteFi...,
    void* ClientData,
    const EOS_PlayerDataStorage_OnWrite...
)

Write new data to a specific file, potentially overwriting any existing file by the same name, to the cloud.

Public function

EOS_EResult

 

EOS_PlayerDataStorageFileTransferRequest_CancelRequest

(
    EOS_HPlayerDataStorageFileTransferR...
)

Attempt to cancel this file request in progress.

Public function

EOS_EResult

 

EOS_PlayerDataStorageFileTransferRequest_GetFilename

(
    EOS_HPlayerDataStorageFileTransferR...,
    uint32_t FilenameStringBufferSizeBy...,
    char* OutStringBuffer,
    int32_t* OutStringLength
)

Get the file name of the file this request is for.

Public function

EOS_EResult

 

EOS_PlayerDataStorageFileTransferRequest_GetFileRequestState

(
    EOS_HPlayerDataStorageFileTransferR...
)

Below are helper functions to retrieve information about a file request handle, or to attempt to cancel a request in progress.

Public function

EOS_NotificationId

 

EOS_Presence_AddNotifyJoinGameAccepted

(
    EOS_HPresence Handle,
    const EOS_Presence_AddNotifyJoinGam...,
    void* ClientData,
    const EOS_Presence_OnJoinGameAccept...
)

Register to receive notifications when a user accepts a join game option via the social overlay.

Public function

EOS_NotificationId

 

EOS_Presence_AddNotifyOnPresenceChanged

(
    EOS_HPresence Handle,
    const EOS_Presence_AddNotifyOnPrese...,
    void* ClientData,
    const EOS_Presence_OnPresenceChange...
)

Register to receive notifications when presence changes.

Public function

EOS_EResult

 

EOS_Presence_CopyPresence

(
    EOS_HPresence Handle,
    const EOS_Presence_CopyPresenceOpti...,
    EOS_Presence_Info ** OutPre...
)

Get a user's cached presence object.

Public function

EOS_EResult

 

EOS_Presence_CreatePresenceModification

(
    EOS_HPresence Handle,
    const EOS_Presence_CreatePresenceMo...,
    EOS_HPresenceModification * Out...
)

Creates a presence modification handle.

Public function

EOS_EResult

 

EOS_Presence_GetJoinInfo

(
    EOS_HPresence Handle,
    const EOS_Presence_GetJoinInfoOptio...,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Gets a join info custom game-data string for a specific user.

Public function

EOS_Bool

 

EOS_Presence_HasPresence

(
    EOS_HPresence Handle,
    const EOS_Presence_HasPresenceOptio...
)

Check if we already have presence for a user

Public function

void

 

EOS_Presence_QueryPresence

(
    EOS_HPresence Handle,
    const EOS_Presence_QueryPresenceOpt ...,
    void* ClientData,
    const EOS_Presence_OnQueryPresenceC ...
)

The Presence methods allow you to query, read other player's presence information, as well as to modify your own.

Public function

void

 

EOS_Presence_RemoveNotifyJoinGameAccepted

(
    EOS_HPresence Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user accepts a join game option via the social overlay.

Public function

void

 

EOS_Presence_RemoveNotifyOnPresenceChanged

(
    EOS_HPresence Handle,
    EOS_NotificationId NotificationId
)

Unregister a previously bound notification handler from receiving presence update notifications

Public function

void

 

EOS_Presence_SetPresence

(
    EOS_HPresence Handle,
    const EOS_Presence_SetPresenceOptio...,
    void* ClientData,
    const EOS_Presence_SetPresenceCompl...
)

Sets your new presence with the data applied to a PresenceModificationHandle.

Public function

EOS_EResult

 

EOS_PresenceModification_DeleteData

(
    EOS_HPresenceModification Handle,
    const EOS_PresenceModification_Dele...
)

Removes one or more rows of user-defined presence data for a local user.

Public function

EOS_EResult

 

EOS_PresenceModification_SetData

(
    EOS_HPresenceModification Handle,
    const EOS_PresenceModification_SetD...
)

Modifies one or more rows of user-defined presence data for a local user.

Public function

EOS_EResult

 

EOS_PresenceModification_SetJoinInfo

(
    EOS_HPresenceModification Handle,
    const EOS_PresenceModification_SetJ...
)

Sets your new join info custom game-data string.

Public function

EOS_EResult

 

EOS_PresenceModification_SetRawRichText

(
    EOS_HPresenceModification Handle,
    const EOS_PresenceModification_SetR...
)

Modifies a user's Rich Presence string to a new state.

Public function

EOS_EResult

 

EOS_PresenceModification_SetStatus

(
    EOS_HPresenceModification Handle,
    const EOS_PresenceModification_SetS...
)

To modify your own presence, you must call EOS_Presence_CreatePresenceModification to create a Presence Modification handle.

Public function

EOS_ProductUserId

 

EOS_ProductUserId_FromString

(
    const char* AccountIdString
)

Retrieve an EOS_EpicAccountId from a raw account ID string.

Public function

EOS_Bool

 

EOS_ProductUserId_IsValid

(
    EOS_ProductUserId AccountId
)

Check whether or not the given account unique id is considered valid

Public function

EOS_EResult

 

EOS_ProductUserId_ToString

(
    EOS_ProductUserId AccountId,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Retrieve a string-ified account ID from an EOS_ProductUserId.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_WrongClient,
    1008
)

Auth parameters are not associated with this client Full account is required

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_HeadlessAccountRequired,
    1010
)

Headless account is required Password reset is required

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_PasswordCannotBeReused,
    1012
)

Password was previously used and cannot be reused Authorization code/exchange code has expired

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ScopeConsentRequired,
    1014
)

Consent has not been given by the user The application has no profile on the backend

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ScopeNotFound,
    1016
)

The requested consent wasn't found on the backend This account has been denied access to login

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_PinGrantCode,
    1020
)

Pin grant code initiated Pin grant code attempt expired

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_PinGrantPending,
    1022
)

Pin grant code attempt pending External auth source did not yield an account

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ExternalAuthExpired,
    1036
)

External auth is expired External auth cannot be removed since it's the last possible way to login

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ExternalAuthRestricted,
    1034
)

External auth cannot be linked to his account due to restrictions External auth cannot be used for login

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_InvalidPlatformToken,
    1006
)

Invalid platform token Auth parameters are not associated with this account

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ExchangeCodeNotFound,
    1040
)

Exchange code not found Originating exchange code session has expired

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_PersistentAuth_AccountNotA...,
    1050
)

The account has been disabled and cannot be used for authentication MFA challenge required

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ParentalControls,
    1070
)

Parental locks are in place Korea real id association required but missing

Public function

 

EOS_RESULT_VALUE

(
    EOS_Friends_InviteAwaitingAcceptanc...,
    2000
)

An outgoing friend invitation is awaiting acceptance; sending another invite to the same user is erroneous There is no friend invitation to accept/reject

Public function

 

EOS_RESULT_VALUE

(
    EOS_Friends_AlreadyFriends,
    2003
)

Users are already friends, so sending another invite is erroneous Users are not friends, so deleting the friend is erroneous

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_ExternalAuthRevoked,
    1032
)

External auth access revoked External auth token cannot be interpreted

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_InvalidToken,
    1004
)

Invalid access token, typically when switching between backend environments Invalid bearer token

Public function

 

EOS_RESULT_VALUE

(
    EOS_CacheDirectoryMissing,
    36
)

Cache directory is not set in platform options. Cache directory is not accessible.

Public function

 

EOS_RESULT_VALUE

(
    EOS_InvalidState,
    38
)

The request failed because resource was in an invalid state Account locked due to login failures

Public function

 

EOS_RESULT_VALUE

(
    EOS_MissingPermissions,
    6
)

If the client does not possess the permission required If the token provided does not represent an account

Public function

 

EOS_RESULT_VALUE

(
    EOS_TooManyRequests,
    8
)

Throttled due to too many requests Async request was already pending

Public function

 

EOS_RESULT_VALUE

(
    EOS_InvalidParameters,
    10
)

Invalid parameters specified for request Invalid request

Public function

 

EOS_RESULT_VALUE

(
    EOS_UnrecognizedResponse,
    12
)

Failed due to unable to parse or recognize a backend response Incompatible client for backend version

Public function

 

EOS_RESULT_VALUE

(
    EOS_NotConfigured,
    14
)

Not configured correctly for use Already configured for use.

Public function

 

EOS_RESULT_VALUE

(
    EOS_NotImplemented,
    16
)

Feature not available on this implementation Operation was canceled (likely by user)

Public function

 

EOS_RESULT_VALUE

(
    EOS_NotFound,
    18
)

The requested information was not found An error occurred during an asynchronous operation, and it will be retried.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Auth_AccountLockedForUpdate,
    1002
)

Account locked by update operation. Refresh token used was invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_NoChange,
    20
)

The request had no effect The request attempted to use multiple or inconsistent API versions

Public function

 

EOS_RESULT_VALUE

(
    EOS_DuplicateNotAllowed,
    24
)

Duplicate entry not allowed Required parameters are missing.

Public function

 

EOS_RESULT_VALUE

(
    EOS_InvalidSandboxId,
    26
)

Sandbox id is invalid Request timed out

Public function

 

EOS_RESULT_VALUE

(
    EOS_PartialResult,
    28
)

A query returned some but not all of the requested results. Client is missing the whitelisted role

Public function

 

EOS_RESULT_VALUE

(
    EOS_Missing_Feature,
    30
)

Client is missing the whitelisted feature The sandbox given to the backend is invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_Invalid_Deployment,
    32
)

The deployment given to the backend is invalid The product id specified to the backend is invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_Invalid_ProductUserID,
    34
)

The product user id specified to the backend is invalid There was a failure with the backend service

Public function

 

EOS_RESULT_VALUE

(
    EOS_Friends_TargetUserTooManyInvite...,
    2005
)

Remote user has too many invites to receive new invites Local user has too many invites to send new invites

Public function

 

EOS_RESULT_VALUE

(
    EOS_LimitExceeded,
    22
)

A maximum limit was exceeded on the client, different from EOS_TooManyRequests Feature or client ID performing the operation has been disabled.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Friends_TargetUserFriendLimitEx...,
    2007
)

Remote user has too many friends to make a new friendship Local user has too many friends to make a new friendship

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_FileHeaderHas...,
    6013
)

User is trying to read file that has header from newer version of SDK.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Presence_DataKeyInvalid,
    3002
)

Request contained data with an invalid key Request contained data with a key too long or too short

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_EncryptionKey...,
    6011
)

Encryption key is not set during SDK init.

Public function

 

EOS_RESULT_VALUE

(
    EOS_InvalidAuth,
    4
)

Failed due to invalid or missing authentication token for user (e.g. not logged in) Failed due to invalid access

Public function

 

EOS_RESULT_VALUE

(
    EOS_Connect_ExternalTokenValidation...,
    7000
)

EOS Auth service deemed the external token invalid EOS Auth user already exists

Public function

 

EOS_RESULT_VALUE

(
    EOS_Connect_AuthExpired,
    7002
)

EOS Auth expired EOS Auth invalid token

Public function

 

EOS_RESULT_VALUE

(
    EOS_Connect_UnsupportedTokenType,
    7004
)

EOS Auth doesn't support this token type EOS Auth Account link failure

Public function

 

EOS_RESULT_VALUE

(
    EOS_Connect_ExternalServiceUnavaila...,
    7006
)

EOS Auth External service for validation was unavailable EOS Auth External Service configuration failure with Dev Portal

Public function

 

EOS_RESULT_VALUE

(
    EOS_Connect_LinkAccountFailedMissin...,
    7008
)

EOS Auth Account link failure.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_NotOwner,
    9000
)

Client has no permissions to modify this lobby Lobby lock required for operation

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_LobbyAlreadyExists,
    9002
)

Lobby already exists in the system Lobby is already in progress

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_TooManyPlayers,
    9004
)

Too many players to register with this session Client has no permissions to access this session

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_InvalidSession,
    9006
)

Invalid session reference Sandbox id associated with auth didn't match

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_InviteFailed,
    9008
)

Invite failed to send Invite was not found with the service

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_UpsertNotAllowed,
    9010
)

This client may not modify the session Backend nodes unavailable to process request

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_HostAtCapacity,
    9012
)

Individual backend node is as capacity Sandbox on node is at capacity

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_TooManyInvites,
    9014
)

User has received too many invites Deployment on node is at capacity

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_RequestInProg...,
    6009
)

Request is in progress User is marked as throttled which means he can't perform some operations because limits are exceeded.

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_DataLengthInv...,
    6007
)

Request data length was invalid Request start index was invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_FileHandleInv...,
    6005
)

Request file handle is not valid Request data is invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_FileSizeTooLa...,
    6003
)

Request operation would grow file too large Request file length is not valid

Public function

 

EOS_RESULT_VALUE

(
    EOS_Presence_DataValueInvalid,
    3004
)

Request contained data with an invalid value Request contained data with a value too long

Public function

 

EOS_RESULT_VALUE

(
    EOS_Presence_RichTextInvalid,
    3006
)

Request contained an invalid rich text string Request contained a rich text string that was too long

Public function

 

EOS_RESULT_VALUE

(
    EOS_Presence_StatusInvalid,
    3008
)

Request contained an invalid status state The entitlement retrieved is stale, requery for updated information

Public function

 

EOS_RESULT_VALUE

(
    EOS_Ecom_CatalogOfferStale,
    4001
)

The offer retrieved is stale, requery for updated information The item or associated structure retrieved is stale, requery for updated information

Public function

 

EOS_RESULT_VALUE

(
    EOS_Ecom_CatalogOfferPriceInvalid,
    4003
)

The one or more offers has an invalid price.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_SessionInProgress,
    5000
)

Session is already in progress Too many players to register with this session

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_NoPermission,
    5002
)

Client has no permissions to access this session Session already exists in the system

Public function

 

EOS_RESULT_VALUE

(
    EOS_Presence_DataInvalid,
    3000
)

Request data was null or invalid Request contained too many or too few unique data items, or the request would overflow the maximum amount of data allowed

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_InvalidLock,
    5004
)

Session lock required for operation Invalid session reference

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_InviteNotFound,
    5008
)

Invite was not found with the service This client may not modify the session

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_AggregationFailed,
    5010
)

Backend nodes unavailable to process request Individual backend node is as capacity

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_SandboxAtCapacity,
    5012
)

Sandbox on node is at capacity An anonymous operation was attempted on a non anonymous session

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_OutOfSync,
    5014
)

Session is currently out of sync with the backend, data is saved locally but needs to sync with backend User has received too many invites

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_PresenceSessionExists,
    5016
)

Presence session already exists for the client Deployment on node is at capacity

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_NotAllowed,
    5018
)

Session operation not allowed Request filename was invalid

Public function

 

EOS_RESULT_VALUE

(
    EOS_PlayerDataStorage_FilenameLengt...,
    6001
)

Request filename was too long Request filename contained invalid characters

Public function

 

EOS_RESULT_VALUE

(
    EOS_Sessions_SandboxNotAllowed,
    5006
)

Sandbox id associated with auth didn't match Invite failed to send

Public function

 

EOS_RESULT_VALUE

(
    EOS_InvalidCredentials,
    2
)

Failed login due to invalid credentials Failed due to invalid or missing user

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_PresenceLobbyExists,
    9018
)

Presence lobby already exists for the client An unexpected error that we cannot identify has occurred.

Public function

 

EOS_RESULT_VALUE

(
    EOS_Success,
    0
)

Successful result. no further error processing needed Failed due to no connection

Public function

 

EOS_RESULT_VALUE

(
    EOS_Lobby_NotAllowed,
    9016
)

Lobby operation not allowed While restoring a lost connection lobby ownership changed and only local member data was updated

Public function

EOS_EResult

 

EOS_SessionDetails_CopyInfo

(
    EOS_HSessionDetails Handle,
    const EOS_SessionDetails_CopyInfoOp...,
    EOS_SessionDetails_Info** ...
)

This class represents the details of a session, including its session properties and the attribution associated with it Locally created or joined active sessions will contain this information as will search results.

Public function

EOS_EResult

 

EOS_SessionDetails_CopySessionAttributeByIndex

(
    EOS_HSessionDetails Handle,
    const EOS_SessionDetails_CopySessio...,
    EOS_SessionDetails_Attribute*&...
)

EOS_SessionDetails_CopySessionAttributeByIndex is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result.

Public function

EOS_EResult

 

EOS_SessionDetails_CopySessionAttributeByKey

(
    EOS_HSessionDetails Handle,
    const EOS_SessionDetails_CopySessio...,
    EOS_SessionDetails_Attribute*&...
)

EOS_SessionDetails_CopySessionAttributeByKey is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result.

Public function

uint32_t

 

EOS_SessionDetails_GetSessionAttributeCount

(
    EOS_HSessionDetails Handle,
    const EOS_SessionDetails_GetSession...
)

Get the number of attributes associated with this session

Public function

void

 

EOS_SessionDetails_Release

(
    EOS_HSessionDetails SessionHandle
)

Release the memory associated with a single session.

Public function

EOS_EResult

 

EOS_SessionModification_AddAttribute

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_AddAt...
)

Associate an attribute with this session An attribute is something that may or may not be advertised with the session.

Public function

void

 

EOS_SessionModification_Release

(
    EOS_HSessionModification SessionMod...
)

Release the memory associated with session modification.

Public function

EOS_EResult

 

EOS_SessionModification_RemoveAttribute

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_Remov...
)

Remove an attribute from this session

Public function

EOS_EResult

 

EOS_SessionModification_SetBucketId

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetBu...
)

To modify sessions, you must call EOS_Sessions_CreateSessionModification to create a Session Modification handle.

Public function

EOS_EResult

 

EOS_SessionModification_SetHostAddress

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetHo...
)

Set the host address associated with this session Setting this is optional, if the value is not set the SDK will fill the value in from the service.

Public function

EOS_EResult

 

EOS_SessionModification_SetInvitesAllowed

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetIn...
)

Allows enabling or disabling invites for this session.

Public function

EOS_EResult

 

EOS_SessionModification_SetJoinInProgressAllowed

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetJo...
)

Set whether or not join in progress is allowed Once a session is started, it will no longer be visible to search queries unless this flag is set or the session returns to the pending or ended state

Public function

EOS_EResult

 

EOS_SessionModification_SetMaxPlayers

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetMa...
)

Set the maximum number of players allowed in this session.

Public function

EOS_EResult

 

EOS_SessionModification_SetPermissionLevel

(
    EOS_HSessionModification Handle,
    const EOS_SessionModification_SetPe...
)

Set the session permissions associated with this session.

Public function

EOS_NotificationId

 

EOS_Sessions_AddNotifyJoinSessionAccepted

(
    EOS_HSessions Handle,
    const EOS_Sessions_AddNotifyJoinSes...,
    void* ClientData,
    const EOS_Sessions_OnJoinSessionAcc...
)

Register to receive notifications when a user accepts a session join game via the social overlay.

Public function

EOS_NotificationId

 

EOS_Sessions_AddNotifySessionInviteAccepted

(
    EOS_HSessions Handle,
    const EOS_Sessions_AddNotifySession...,
    void* ClientData,
    const EOS_Sessions_OnSessionInviteA...
)

Register to receive notifications when a user accepts a session invite via the social overlay.

Public function

EOS_NotificationId

 

EOS_Sessions_AddNotifySessionInviteReceived

(
    EOS_HSessions Handle,
    const EOS_Sessions_AddNotifySession...,
    void* ClientData,
    const EOS_Sessions_OnSessionInviteR...
)

Register to receive session invites.

Public function

EOS_EResult

 

EOS_Sessions_CopyActiveSessionHandle

(
    EOS_HSessions Handle,
    const EOS_Sessions_CopyActiveSessio...,
    EOS_HActiveSession * OutSession...
)

Create a handle to an existing active session.

Public function

EOS_EResult

 

EOS_Sessions_CopySessionHandleByInviteId

(
    EOS_HSessions Handle,
    const EOS_Sessions_CopySessionHandl...,
    EOS_HSessionDetails * OutSessio...
)

EOS_Sessions_CopySessionHandleByInviteId is used to immediately retrieve a handle to the session information from after notification of an invite If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Public function

EOS_EResult

 

EOS_Sessions_CopySessionHandleByUiEventId

(
    EOS_HSessions Handle,
    const EOS_Sessions_CopySessionHandl...,
    EOS_HSessionDetails * OutSessio...
)

EOS_Sessions_CopySessionHandleByUiEventId is used to immediately retrieve a handle to the session information from after notification of a join game event.

Public function

EOS_EResult

 

EOS_Sessions_CopySessionHandleForPresence

(
    EOS_HSessions Handle,
    const EOS_Sessions_CopySessionHandl...,
    EOS_HSessionDetails * OutSessio...
)

EOS_Sessions_CopySessionHandleForPresence is used to immediately retrieve a handle to the session information which was marked with bPresenceEnabled on create or join.

Public function

EOS_EResult

 

EOS_Sessions_CreateSessionModification

(
    EOS_HSessions Handle,
    const EOS_Sessions_CreateSessionMod...,
    EOS_HSessionModification * OutS...
)

The Session Interface is used to manage sessions that can be advertised with the backend service All Session Interface calls take a handle of type EOS_HSessions as the first parameter.

Public function

EOS_EResult

 

EOS_Sessions_CreateSessionSearch

(
    EOS_HSessions Handle,
    const EOS_Sessions_CreateSessionSea...,
    EOS_HSessionSearch * OutSession...
)

Create a session search handle.

Public function

void

 

EOS_Sessions_DestroySession

(
    EOS_HSessions Handle,
    const EOS_Sessions_DestroySessionOp...,
    void* ClientData,
    const EOS_Sessions_OnDestroySession...
)

Destroy a session given a session name

Public function

EOS_EResult

 

EOS_Sessions_DumpSessionState

(
    EOS_HSessions Handle,
    const EOS_Sessions_DumpSessionState...
)

Dump the contents of active sessions that exist locally to the log output, purely for debug purposes

Public function

void

 

EOS_Sessions_EndSession

(
    EOS_HSessions Handle,
    const EOS_Sessions_EndSessionOption...,
    void* ClientData,
    const EOS_Sessions_OnEndSessionCall...
)

Mark a session as ended, making it available to find if "join in progress" was disabled.

Public function

uint32_t

 

EOS_Sessions_GetInviteCount

(
    EOS_HSessions Handle,
    const EOS_Sessions_GetInviteCountOp...
)

Get the number of known invites for a given user

Public function

EOS_EResult

 

EOS_Sessions_GetInviteIdByIndex

(
    EOS_HSessions Handle,
    const EOS_Sessions_GetInviteIdByInd...,
    char* OutBuffer,
    int32_t* InOutBufferLength
)

Retrieve an invite id from a list of active invites for a given user

Public function

EOS_EResult

 

EOS_Sessions_IsUserInSession

(
    EOS_HSessions Handle,
    const EOS_Sessions_IsUserInSessionO...
)

EOS_Sessions_IsUserInSession returns whether or not a given user can be found in a specified session

Public function

void

 

EOS_Sessions_JoinSession

(
    EOS_HSessions Handle,
    const EOS_Sessions_JoinSessionOptio...,
    void* ClientData,
    const EOS_Sessions_OnJoinSessionCal...
)

Join a session, creating a local session under a given session name.

Public function

void

 

EOS_Sessions_QueryInvites

(
    EOS_HSessions Handle,
    const EOS_Sessions_QueryInvitesOpti...,
    void* ClientData,
    const EOS_Sessions_OnQueryInvitesCa...
)

Retrieve all existing invites for a single user

Public function

void

 

EOS_Sessions_RegisterPlayers

(
    EOS_HSessions Handle,
    const EOS_Sessions_RegisterPlayersO...,
    void* ClientData,
    const EOS_Sessions_OnRegisterPlayer...
)

Register a group of players with the session, allowing them to invite others or otherwise indicate they are part of the session for determining a full session

Public function

void

 

EOS_Sessions_RejectInvite

(
    EOS_HSessions Handle,
    const EOS_Sessions_RejectInviteOpti...,
    void* ClientData,
    const EOS_Sessions_OnRejectInviteCa...
)

Reject an invite from another player.

Public function

void

 

EOS_Sessions_RemoveNotifyJoinSessionAccepted

(
    EOS_HSessions Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user accepts a session join game via the social overlay.

Public function

void

 

EOS_Sessions_RemoveNotifySessionInviteAccepted

(
    EOS_HSessions Handle,
    EOS_NotificationId InId
)

Unregister from receiving notifications when a user accepts a session invite via the social overlay.

Public function

void

 

EOS_Sessions_RemoveNotifySessionInviteReceived

(
    EOS_HSessions Handle,
    EOS_NotificationId InId
)

Unregister from receiving session invites.

Public function

void

 

EOS_Sessions_SendInvite

(
    EOS_HSessions Handle,
    const EOS_Sessions_SendInviteOption...,
    void* ClientData,
    const EOS_Sessions_OnSendInviteCall...
)

Send an invite to another player.

Public function

void

 

EOS_Sessions_StartSession

(
    EOS_HSessions Handle,
    const EOS_Sessions_StartSessionOpti...,
    void* ClientData,
    const EOS_Sessions_OnStartSessionCa...
)

Mark a session as started, making it unable to find if session properties indicate "join in progress" is not available

Public function

void

 

EOS_Sessions_UnregisterPlayers

(
    EOS_HSessions Handle,
    const EOS_Sessions_UnregisterPlayer...,
    void* ClientData,
    const EOS_Sessions_OnUnregisterPlay...
)

Unregister a group of players with the session, freeing up space for others to join

Public function

void

 

EOS_Sessions_UpdateSession

(
    EOS_HSessions Handle,
    const EOS_Sessions_UpdateSessionOpt...,
    void* ClientData,
    const EOS_Sessions_OnUpdateSessionC...
)

Update a session given a session modification handle created via EOS_Sessions_CreateSessionModification or EOS_Sessions_UpdateSessionModification

Public function

EOS_EResult

 

EOS_Sessions_UpdateSessionModification

(
    EOS_HSessions Handle,
    const EOS_Sessions_UpdateSessionMod...,
    EOS_HSessionModification * OutS...
)

Creates a session modification handle (EOS_HSessionModification).

Public function

EOS_EResult

 

EOS_SessionSearch_CopySearchResultByIndex

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_CopySearchR...,
    EOS_HSessionDetails * OutSessio...
)

EOS_SessionSearch_CopySearchResultByIndex is used to immediately retrieve a handle to the session information from a given search result.

Public function

void

 

EOS_SessionSearch_Find

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_FindOptions...,
    void* ClientData,
    const EOS_SessionSearch_OnFindCallb...
)

Find sessions matching the search criteria setup via this session search handle.

Public function

uint32_t

 

EOS_SessionSearch_GetSearchResultCount

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_GetSearchRe...
)

Get the number of search results found by the search parameters in this search

Public function

void

 

EOS_SessionSearch_Release

(
    EOS_HSessionSearch SessionSearchHan...
)

Release the memory associated with a session search.

Public function

EOS_EResult

 

EOS_SessionSearch_RemoveParameter

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_RemoveParam...
)

Remove a parameter from the array of search criteria.

Public function

EOS_EResult

 

EOS_SessionSearch_SetMaxResults

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_SetMaxResul...
)

Set the maximum number of search results to return in the query, can't be more than EOS_SESSIONS_MAX_SEARCH_RESULTS

Public function

EOS_EResult

 

EOS_SessionSearch_SetParameter

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_SetParamete...
)

Add a parameter to an array of search criteria combined via an implicit AND operator.

Public function

EOS_EResult

 

EOS_SessionSearch_SetSessionId

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_SetSessionI...
)

Class responsible for the creation, setup, and execution of a search query.

Public function

EOS_EResult

 

EOS_SessionSearch_SetTargetUserId

(
    EOS_HSessionSearch Handle,
    const EOS_SessionSearch_SetTargetUs...
)

Set a target user id to find and will return at most one search result.

Public function

EOS_EResult

 

EOS_Shutdown()

Tear down the Epic Online Services SDK.

Public function

EOS_EResult

 

EOS_Stats_CopyStatByIndex

(
    EOS_HStats Handle,
    const EOS_Stats_CopyStatByIndexOpti ...,
    EOS_Stats_Stat ** OutStat
)

Fetches a stat from a given index.

Public function

EOS_EResult

 

EOS_Stats_CopyStatByName

(
    EOS_HStats Handle,
    const EOS_Stats_CopyStatByNameOptio ...,
    EOS_Stats_Stat ** OutStat
)

Fetches a stat from cached stats by name.

Public function

uint32_t

 

EOS_Stats_GetStatsCount

(
    EOS_HStats Handle,
    const EOS_Stats_GetStatCountOptions ...
)

Fetch the number of stats that are cached locally.

Public function

void

 

EOS_Stats_IngestStat

(
    EOS_HStats Handle,
    const EOS_Stats_IngestStatOptions &...,
    void* ClientData,
    const EOS_Stats_OnIngestStatComplet ...
)

Ingest a stat by the amount specified in Options.

Public function

void

 

EOS_Stats_QueryStats

(
    EOS_HStats Handle,
    const EOS_Stats_QueryStatsOptions &...,
    void* ClientData,
    const EOS_Stats_OnQueryStatsComplet ...
)

Query for a list of stats for a specific player.

Public function

void

 

EOS_Stats_Stat_Release

(
    EOS_Stats_Stat * Stat
)

Release the memory associated with a stat.

Public function

EOS_EResult

 

EOS_UI_AcknowledgeEventId

(
    EOS_HUI Handle,
    const EOS_UI_AcknowledgeEventIdOpti ...
)

Lets the SDK know that the given UI event ID has been acknowledged and should be released.

Public function

EOS_Bool

 

EOS_UI_GetFriendsVisible

(
    EOS_HUI Handle,
    const EOS_UI_GetFriendsVisibleOptio ...
)

Gets the friends overlay visibility.

Public function

EOS_UI_ENotificationLocation

 

EOS_UI_GetNotificationLocationPreference

(
    EOS_HUI Handle
)

Returns the current notification location display preference.

Public function

EOS_UI_EKeyCombination

 

EOS_UI_GetToggleFriendsKey

(
    EOS_HUI Handle,
    const EOS_UI_GetToggleFriendsKeyOpt ...
)

Returns the current Toggle Friends Key.

Public function

void

 

EOS_UI_HideFriends

(
    EOS_HUI Handle,
    const EOS_UI_HideFriendsOptions ...,
    void* ClientData,
    const EOS_UI_OnHideFriendsCallback ...
)

Hides the active overlay.

Public function

EOS_Bool

 

EOS_UI_IsValidKeyCombination

(
    EOS_HUI Handle,
    EOS_UI_EKeyCombination KeyCombinati...
)

Determine if a key combination is valid.

Public function

 

EOS_UI_KEY_CONSTANT

(
    EOS_UIK_,
    ModifierShift,
    16
)

Number of bits to shift the modifiers into the integer. A mask to isolate the single key.

Public function

EOS_EResult

 

EOS_UI_SetDisplayPreference

(
    EOS_HUI Handle,
    const EOS_UI_SetDisplayPreferenceOp ...
)

Define any preferences for any display settings.

Public function

EOS_EResult

 

EOS_UI_SetToggleFriendsKey

(
    EOS_HUI Handle,
    const EOS_UI_SetToggleFriendsKeyOpt ...
)

Updates the current Toggle Friends Key.

Public function

void

 

EOS_UI_ShowFriends

(
    EOS_HUI Handle,
    const EOS_UI_ShowFriendsOptions ...,
    void* ClientData,
    const EOS_UI_OnShowFriendsCallback ...
)

The UI Interface is used to access the overlay UI.

Public function

EOS_EResult

 

EOS_UserInfo_CopyExternalUserInfoByAccountId

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_CopyExternalUser ...,
    EOS_UserInfo_ExternalUserInfo *...
)

Fetches an external user info for a given external account id.

Public function

EOS_EResult

 

EOS_UserInfo_CopyExternalUserInfoByAccountType

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_CopyExternalUser ...,
    EOS_UserInfo_ExternalUserInfo *...
)

Fetches an external user info for a given external account type.

Public function

EOS_EResult

 

EOS_UserInfo_CopyExternalUserInfoByIndex

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_CopyExternalUser ...,
    EOS_UserInfo_ExternalUserInfo *...
)

Fetches an external user info from a given index.

Public function

EOS_EResult

 

EOS_UserInfo_CopyUserInfo

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_CopyUserInfoOpti ...,
    EOS_UserInfo ** OutUserInfo
)

EOS_UserInfo_CopyUserInfo is used to immediately retrieve a copy of user information for an account ID, cached by a previous call to EOS_UserInfo_QueryUserInfo.

Public function

void

 

EOS_UserInfo_ExternalUserInfo_Release

Release the memory associated with external user info.

Public function

uint32_t

 

EOS_UserInfo_GetExternalUserInfoCount

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_GetExternalUserI ...
)

Fetch the number of external user infos that are cached locally.

Public function

void

 

EOS_UserInfo_QueryUserInfo

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_QueryUserInfoOpt ...,
    void* ClientData,
    const EOS_UserInfo_OnQueryUserInfoC ...
)

The UserInfo Interface is used to receive user information for Epic account IDs from the backend services and to retrieve that information once it is cached.

Public function

void

 

EOS_UserInfo_QueryUserInfoByDisplayName

(
    EOS_HUserInfo Handle,
    const EOS_UserInfo_QueryUserInfoByD ...,
    void* ClientData,
    const EOS_UserInfo_OnQueryUserInfoB ...
)

EOS_UserInfo_QueryUserInfoByDisplayName is used to start an asynchronous query to retrieve user information by display name.

Public function

void

 

EOS_UserInfo_Release

(
    EOS_UserInfo * UserInfo
)

Release the memory associated with an EOS_UserInfo structure.

Variables

Name Description

Public variable

 

KeyTypeMask