> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XblMultiplayerSessionProperties

> XblMultiplayerSessionProperties

# XblMultiplayerSessionProperties

Um conjunto de propriedades associadas a esta sessão. Qualquer jogador pode modificar essas propriedades.

## Sintaxe

```cpp theme={null}
typedef struct XblMultiplayerSessionProperties {  
    const char** Keywords;  
    size_t KeywordCount;  
    XblMultiplayerSessionRestriction JoinRestriction;  
    XblMultiplayerSessionRestriction ReadRestriction;  
    uint32_t* TurnCollection;  
    size_t TurnCollectionCount;  
    const char* MatchmakingTargetSessionConstantsJson;  
    const char* SessionCustomPropertiesJson;  
    const char* MatchmakingServerConnectionString;  
    const char** ServerConnectionStringCandidates;  
    size_t ServerConnectionStringCandidatesCount;  
    uint32_t* SessionOwnerMemberIds;  
    size_t SessionOwnerMemberIdsCount;  
    XblDeviceToken HostDeviceToken;  
    bool Closed;  
    bool Locked;  
    bool AllocateCloudCompute;  
    bool MatchmakingResubmit;  
} XblMultiplayerSessionProperties  
```

### Membros

*Keywords*\
Tipo: const char\*\*

Uma coleção de palavras-chave associadas à sessão (opcional, pode estar vazia).

*KeywordCount*\
Tipo: size\_t

O número de palavras-chave.

*JoinRestriction*\
Tipo: [XblMultiplayerSessionRestriction](/pt-BR/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionrestriction)

Restringe quem pode ingressar em sessões "open". (Não tem efeito sobre reservas, o que significa que não tem impacto em sessões "private" e "visible".) O padrão é "none". Se for "local", somente usuários cujo DeviceId do token corresponda ao de outra pessoa que já esteja na sessão e com "active": true. Se for "followed", somente usuários locais (conforme definido acima) e usuários seguidos por um membro existente (não reservado) da sessão podem ingressar sem uma reserva.

*ReadRestriction*\
Tipo: [XblMultiplayerSessionRestriction](/pt-BR/reference/live/xsapi-c/multiplayer_c/enums/xblmultiplayersessionrestriction)

Restringe quem pode ler sessões "open". (Não tem efeito sobre reservas, o que significa que não tem impacto em sessões "private" e "visible".) O padrão é "none". Se for "local", somente usuários cujo DeviceId do token corresponda ao de outra pessoa que já esteja na sessão e com "active": true. Se for "followed", somente usuários locais (conforme definido acima) e usuários seguidos por um membro existente (não reservado) da sessão podem ler sem uma reserva. A restrição de leitura se aplica a sessões com visibilidade "open" ou "visible" e determina quem pode ler a sessão sem um convite. A restrição de leitura deve ser pelo menos tão acessível quanto a restrição de ingresso, ou seja, 'joinRestriction' não pode ser definido como "followed" sem também definir 'readRestriction'."

*TurnCollection*\
Tipo: uint32\_t\*

Uma coleção de MemberIds da sessão que indica de quem é a vez.

*TurnCollectionCount*\
Tipo: size\_t

O número de entradas na matriz TurnCollection.

*MatchmakingTargetSessionConstantsJson*\
Tipo: const char\*

Uma cadeia de caracteres JSON que representa as constantes da sessão de destino.

*SessionCustomPropertiesJson*\
Tipo: const char\*

Cadeia de caracteres JSON que especifica as propriedades personalizadas da sessão. Elas podem ser alteradas a qualquer momento. Ao alterá-las, chame multiplayer\_service::write\_session para gravar as alterações no serviço.

*MatchmakingServerConnectionString*\
Tipo: const char\*

Força o uso de uma cadeia de conexão específica. Isso é útil em cenários de ingresso em sessões em andamento.

*ServerConnectionStringCandidates*\
Tipo: const char\*\*

A lista ordenada de cadeias de conexão que a sessão pode usar para se conectar a um servidor de jogo. Em geral, os títulos devem usar a primeira da lista, mas títulos sofisticados podem usar um mecanismo personalizado para escolher uma das outras (por exemplo, com base na carga).

*ServerConnectionStringCandidatesCount*\
Tipo: size\_t

O número de entradas na matriz ServerConnectionStringCandidates.

*SessionOwnerMemberIds*\
Tipo: uint32\_t\*

MemberIds da sessão dos proprietários da sessão.

*SessionOwnerMemberIdsCount*\
Tipo: size\_t

O número de entradas na matriz SessionOwnerMemberIds.

*HostDeviceToken*\
Tipo: [XblDeviceToken](/pt-BR/reference/live/xsapi-c/multiplayer_c/structs/xbldevicetoken)

Token de dispositivo do host. Deve corresponder ao "deviceToken" de pelo menos um membro; caso contrário, este campo será excluído. Se "peerToHostRequirements" e "host" estiverem definidos, o estágio de medição presumirá que o host fornecido é o host correto e medirá as métricas somente para esse host.

*Closed*\
Tipo: bool

Controla se é possível ingressar em uma sessão, independentemente da visibilidade, da restrição de ingresso e do espaço disponível na sessão. Não afeta as reservas. O padrão é false.

*Locked*\
Tipo: bool

Se for true, permitirá que os membros da sessão sejam bloqueados, de modo que, se um usuário sair, ele poderá voltar à sessão, mas nenhum outro usuário poderá ocupar essa vaga. O padrão é false.

*AllocateCloudCompute*\
Tipo: bool

Quando definido como true por um cliente, dispara uma tentativa de alocação do XBOX Live Compute pelo MPSD. O padrão é false.

*MatchmakingResubmit*\
Tipo: bool

True se a partida encontrada não deu certo e precisa ser reenviada. Defina como false para sinalizar que a partida funcionou e que o serviço de matchmaking pode liberar a sessão.

## Requisitos

**Cabeçalho:** multiplayer\_c.h

## Confira também

[multiplayer\_c](/pt-BR/reference/live/xsapi-c/multiplayer_c/multiplayer_c_members)


## Related topics

- [Tópicos avançados de sessões multiplayer](/pt-BR/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-details.md)
- [Visão geral do Multiplayer Session Directory](/pt-BR/services/xbox-services/multiplayer/mpsd/live-mpsd-overview.md)
- [XblMultiplayerSessionSessionProperties](/pt-BR/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsessionproperties.md)
- [XblMultiplayerSessionPropertiesSetKeywords](/pt-BR/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionpropertiessetkeywords.md)
- [XblMultiplayerSessionDeleteCustomPropertyJson](/pt-BR/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiondeletecustompropertyjson.md)
