scCreateSession
Requests the Competition service to create a session ID and keep track of the session that is about to start.
- SCResult scCreateSession(
- SCInterfacePtr theInterface,
- const GSLoginCertificate * theCertificate,
- const GSLoginPrivateData * thePrivateData,
- SCCreateSessionCallback theCallback,
- gsi_time theTimeoutMs,
- void * theUserData );
Routine | Required Header | Distribution |
---|---|---|
scCreateSession | <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 Inteface Object
- theCertificate
- [in] Certificate obtained from the auth service.
- thePrivateData
- [in] Private Data obtained from the auth service.
- theCallback
- [in] The callback called when create session completes.
- theTimeoutMs
- [in] Timeout in case the create session operation takes too long
- theUserData
- [in] User data for use in callbacks. Note that it is a constant pointer in the callback
Remarks
The certificate and private data may be NULL if the local client is an unauthenticated dedicated server. The function should be called by the host after initializing the SDK, and obtaining a certificate and private data from the authentication service. The competition service creates and sends a session ID to the host. The callback passed in will get called even if the request failed.
Section Reference: Gamespy Competition SDK
See Also: SCCreateSessionCallback, scInitialize