EOS_Sessions_CreateSessionModification

EOS API reference page for EOS_Sessions_CreateSessionModification

This function is part of the Sessions Interface.

Remarks

Creates a session modification handle (EOS_HSessionModification). The session modification handle is used to build a new session and can be applied with EOS_Sessions_UpdateSession The EOS_HSessionModification must be released by calling EOS_SessionModification_Release once it no longer needed.

Return Value

EOS_Success if we successfully created the Session Modification Handle pointed at in OutSessionModificationHandle, or an error result if the input data was invalid

See Also

EOS_SessionModification_Release, EOS_Sessions_UpdateSession, EOS_HSessionModification

Parameters

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_CreateSessionModificationOptions* Options

Required fields for the creation of a session such as a name, bucketid, and max players

EOS_HSessionModification* OutSessionModificationHandle

Pointer to a Session Modification Handle only set if successful

Related API Members