Called to tell the backend the type of report that the player or host will send.

SCResult scSetReportIntention(

const SCInterfacePtr theInterface,

const gsi_u8 theConnectionId[SC_CONNECTION_GUID_SIZE],

gsi_bool isAuthoritative,

const GSLoginCertificate * theCertificate,

const GSLoginPrivateData * thePrivateData,

SCSetReportIntentionCallback theCallback,

gsi_time theTimeoutMs,

const void * theUserData );

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

theInterface

[ref] A valid SC Interface Object.

theConnectionId

[in] The player's former ConnectionId if he was previously in the same match. Set to NULL if unused.

isAuthoritative

[in] flag set if the snapshot being reported will be an authoratative.

theCertificate

[ref] Certificate obtained from the authentiocation web service.

thePrivateData

[ref] Private data obtained from the authentiocation web service.

theCallback

[ref] The callback called when set report intention completes.

theTimeoutMs

[in] The amount of time to spend on the operation before a timeout occurs.

theUserData

[ref] Application data that may be used in the callback.

Remarks

The should be called by both the host and client before sending a report. The host should have created a session before calling this. It allows the server to know ahead of time what type of report will be sent. Reports submitted without an intention will be discarded.

Section Reference: Gamespy Competition SDK

See Also: scCreateSession, SCSetReportIntentionCallback, scSubmitReport