scReportSetPlayerData

GameSpy SDK

scReportSetPlayerData

Sets initial player data in the report specified.

SCResult scReportSetPlayerData(
SCReportPtr theReport,
gsi_u32 thePlayerIndex,
const gsi_u8 thePlayerConnectionId[SC_CONNECTIONID_LENGTH],
gsi_u32 thePlayerTeamIndex,
SCGameResult theResult,
gsi_u32 theProfileId,
const GSLoginCertificate * theCertificate,
const gsi_u8 theAuthData[16] );
RoutineRequired HeaderDistribution
scReportSetPlayerData<sc.h>SDKZIP

Return Value

Enum value used to indicate the specific result of the request. This will return SCResult_NO_ERROR if the request completed successfully.

Parameters

theReport
[ref] A valid SC Report Object
thePlayerIndex
[in] Index of the player (0 - Number of players)
thePlayerConnectionId
[in] Connection ID that the player received from the competition backend
thePlayerTeamIndex
[in] Team index of the player, if that player is on a team.
theResult
[in] Standard SC Game result
theProfileId
[in] Profile ID of the player
theCertificate
[in] Certificate obtained from the auth service.
theAuthData
[in] Authentication data

Remarks

A report must have been created prior to using this function. Each player must have a valid login certificate from the authentication service also. This function should be called after a new player is added to the report. Any key/value pairs that need to be added should be done after calling this function.