EOS_Sessions_UpdateSessionModification

EOS API reference page for EOS_Sessions_UpdateSessionModification

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Creates a session modification handle (EOS_HSessionModification). The session modification handle is used to modify an existing session and can be applied with EOS_Sessions_UpdateSession. The EOS_HSessionModification must be released by calling EOS_SessionModification_Release once it is 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

EOS_Sessions_UpdateSessionModification

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_UpdateSessionModificationOptions* Options

Required fields such as session name

EOS_HSessionModification* OutSessionModificationHandle

Pointer to a Session Modification Handle only set if successful

Related API Members

This function is part of the Sessions Interface.

Remarks

Creates a session modification handle ({SessionModification}). The session modification handle is used to modify an existing session and can be applied with {UpdateSession}. The {SessionModification} must be released by calling {SessionModification.Release} once it is no longer needed.

Return Value

{Result.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

{SessionModification.Release}, {UpdateSession}, {SessionModification}

Parameters

Sessions.SessionsInterface.UpdateSessionModification

Parameter Type And Name

Usage Information

UpdateSessionModificationOptions options

Required fields such as session name

SessionModification outSessionModificationHandle

Pointer to a Session Modification Handle only set if successful

Related API Members