Skip to main content

XGameStreamingGetSessionId

Cette API retourne une chaîne opaque terminée par un caractère nul qui identifie de façon unique la session de diffusion en continu du client spécifié.

Syntaxe

Paramètres

client   _In_
Type : XGameStreamingClientId
Client de diffusion en continu interrogé. sessionIdSize   _In_
Type : size_t
Taille de la mémoire tampon sessionId. sessionId   _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
Type : char*
Mémoire tampon qui sera remplie avec l’ID de session du client spécifié. sessionIdUsed   _Out_opt_
Type : size_t*
Taille en octets de la valeur retournée dans la mémoire tampon sessionId (y compris le caractère nul de fin).

Valeur de retour

Type : HRESULT Retourne S_OK en cas de réussite; sinon, retourne un code d’erreur.

Erreurs potentielles

Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur.

Remarques

La chaîne écrite dans sessionId ne sera jamais plus grande que SessionIdMaxBytes; elle peut donc être préallouée. La disposition et le contenu d’un sessionId peuvent changer ultérieurement; il doit donc être interprété uniquement comme une chaîne opaque. Comme pour les autres API de propriétés du client, il est recommandé d’utiliser XGameStreamingRegisterClientPropertiesChanged pour inscrire un rappel pour les modifications du sessionId.

Exemple

Configuration requise

En-tête : xgamestreaming.h
Bibliothèque : xgameruntime.lib
Plateformes prises en charge : Windows, consoles de la famille XBOX One et consoles XBOX Series

Voir aussi

XGameStreaming XGameStreamingRegisterClientPropertiesChanged
Last modified on October 6, 2026