Skip to main content

XGameStreamingGetSessionId

Esta API retorna uma cadeia de caracteres opaca terminada em nulo que identifica exclusivamente a sessão de streaming do cliente especificado.

Sintaxe

Parâmetros

client   _In_
Tipo: XGameStreamingClientId
O cliente de streaming que está sendo consultado. sessionIdSize   _In_
Tipo: size_t
O tamanho do buffer sessionId. sessionId   _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
Tipo: char*
O buffer que será preenchido com a ID de sessão do cliente especificado. sessionIdUsed   _Out_opt_
Tipo: size_t*
O tamanho, em bytes, do valor retornado no buffer sessionId (incluindo o terminador nulo).

Valor retornado

Tipo: HRESULT Retornará S_OK se for bem-sucedido; caso contrário, retornará um código de erro.

Erros potenciais

Para obter uma lista de códigos de erro, consulte Códigos de erro.

Comentários

A cadeia de caracteres gravada em sessionId nunca será maior que SessionIdMaxBytes; portanto, ela pode ser pré-alocada. O layout/conteúdo de um sessionId pode mudar posteriormente e, portanto, deve ser interpretado apenas como uma cadeia de caracteres opaca. Assim como em outras APIs de propriedades do cliente, é recomendável usar XGameStreamingRegisterClientPropertiesChanged para registrar um retorno de chamada para alterações no sessionId.

Exemplo

Requisitos

Cabeçalho: xgamestreaming.h
Biblioteca: xgameruntime.lib
Plataformas com suporte: Windows, consoles da família XBOX One e consoles XBOX Series

Confira também

XGameStreaming XGameStreamingRegisterClientPropertiesChanged
Last modified on October 6, 2026