scSubmitReport
Initiates the submission of a report.
- SCResult scSubmitReport(
- const SCInterfacePtr theInterface,
- const SCReportPtr theReport,
- gsi_bool isAuthoritative,
- const GSLoginCertificate * theCertificate,
- const GSLoginPrivateData * thePrivateData,
- SCSubmitReportCallback theCallback,
- gsi_time theTimeoutMs,
- void * theUserData );
Routine | Required Header | Distribution |
---|---|---|
scSubmitReport | <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
- theInterface
- [in] A valid SC Interface Object.
- theReport
- [in] A valid SC Report object
- isAuthoritative
- [in] Flag to tell if the snapshot is authoritative
- theCertificate
- [in] Certificate Obtained from the auth service.
- thePrivateData
- [in] Private Data Obtained from the auth service.
- theCallback
- [in] Callback to be called when submit report completes.
- theTimeoutMs
- [in] The amount of time before a timeout occurs
- theUserData
- [in] Application data that may be used in the callback
Remarks
Once the report has been completed with a call to scReportEnd, the player or host can call this function to submit a report. The certificate and private data are both required to submit a report. Incomplete reports will be discarded. The callback passed in will tell the game the result of the operation.
Section Reference: Gamespy Competition SDK
See Also: scInitialize, scCreateSession, scSetReportIntention, scReportEnd, SCSubmitReportCallback