Share via

XblMultiplayerSessionConstantsSetTimeouts

  • Article

Sets the timeouts for the session. This can only be set when creating a new session.

Syntax

HRESULT XblMultiplayerSessionConstantsSetTimeouts(  
         XblMultiplayerSessionHandle handle,  
         uint64_t memberReservedTimeout,  
         uint64_t memberInactiveTimeout,  
         uint64_t memberReadyTimeout,  
         uint64_t sessionEmptyTimeout  
)

Parameters

handle   _In_
Type: XblMultiplayerSessionHandle

Handle to the multiplayer session.

memberReservedTimeout   _In_
Type: uint64_t

The timeout for a member reservation, in milliseconds. A value of 0 is allowed and indicates an immediate timeout. If the timeout is not specified, it is considered infinite.

memberInactiveTimeout   _In_
Type: uint64_t

The timeout for a member to be considered inactive, in milliseconds. A value of 0 is allowed and indicates an immediate timeout. If the timeout is not specified, it is considered infinite.

memberReadyTimeout   _In_
Type: uint64_t

The timeout for a member to be considered ready, in milliseconds. A value of 0 is allowed and indicates an immediate timeout. If the timeout is not specified, it is considered infinite.

sessionEmptyTimeout   _In_
Type: uint64_t

The timeout for an empty session, in milliseconds. A value of 0 is allowed and indicates an immediate timeout. If the timeout is not specified, it is considered infinite.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Requirements

Header: multiplayer_c.h

Library: Microsoft.Xbox.Services.14x.GDK.C.lib

See also

multiplayer_c