scSetSessionId

GameSpy SDK

scSetSessionId

Used to set the session ID for the current game session.

SCResult scSetSessionId(
const SCInterfacePtr theInterface,
const gsi_u8 theSessionId[SC_SESSION_GUID_SIZE] );
RoutineRequired HeaderDistribution
scSetSessionId<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
theSessionId
[in] The session ID - this has a constant length of SC_SESSION_GUID_SIZE

Remarks

The session ID indentifies a single game session happening between players. Players should use the scGetSessionId function in order to obtain the session ID. This should not be called if a session has not yet been created.