scReportAddByteValue

GameSpy SDK

scReportAddByteValue

Adds a byte value to the report for a specific key.

SCResult scReportAddByteValue(
SCReportPtr theReportData,
gsi_u16 theKeyId,
gsi_i8 theValue );
RoutineRequired HeaderDistribution
scReportAddByteValue<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

theReportData
[in] A valid SC Report object
theKeyId
[in] Key Identifier for reporting data
theValue
[in] 8 bit Byte value representation of the data

Remarks

The host or player can call this function to add either global, player-, or team-specific data. A report needs to be created before calling this function. For global keys, this function can only be called after starting global data. For player or teams, a new player or team needs to be added.