> ## 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.

# XGameStreamingGetSessionId

> XGameStreamingGetSessionId

# 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

```cpp theme={null}
HRESULT XGameStreamingGetSessionId(
        XGameStreamingClientId client,
        size_t sessionIdSize,
        char* sessionId,
        size_t* sessionIdUsed
)
```

### 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

| Code d'erreur | Valeur d'erreur | Cause de l'erreur |
| - | - | - |
| E\_GAMESTREAMING\_NOT\_INITIALIZED | 0x89245400 | Le runtime XGameStreaming n'a pas été initialisé. Appelez [XGameStreamingInitialize](/fr-CA/reference/system/xgamestreaming/functions/xgamestreaminginitialize) avant d'appeler d'autres API. |
| E\_GAMESTREAMING\_CLIENT\_NOT\_CONNECTED | 0x89245401 | Le client spécifié n'est pas connecté. |
| E\_GAMESTREAMING\_NO\_DATA | 0x89245402 | Les données demandées ne sont pas disponibles. Elles pourraient l'être plus tard. |
| E\_NOT\_SUFFICIENT\_BUFFER | 0x7A | *sessionId* n'est pas assez grand pour contenir l'ID de session et le caractère nul de fin. |

Pour obtenir la liste des codes d'erreur, consultez [Codes d'erreur](/fr-CA/reference/errorcodes).

## 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

```C++ theme={null}
// Register for client properties changed notifications 
void GameStreamingClientManager::OnClientConnected(XGameStreamingClientId client)
{
    XGameStreamingClientPropertiesChangedRegistrationToken token = {0};
    XGameStreamingRegisterClientPropertiesChanged(
            client, m_taskQueue, this, &OnClientPropertiesChanged, &token);
}

void GameStreamingClientManager::OnClientPropertiesChanged(
    void* context,
    XGameStreamingClientId client,
    uint32_t updatedPropertiesCount,
    XGameStreamingClientProperty* updatedProperties)
{
    for (uint32_t i = 0; i < updatedPropertiesCount; ++i)
    {
        switch (updatedProperties[i])
        {
        case XGameStreamingClientProperty::SessionId:
        {
            // allocate memory for sessionId
            char sessionId[SessionIdMaxBytes];

            // get session id of the client
            size_t bytesUsed = 0;
            HRESULT hr = XGameStreamingGetSessionId(client, _countof(sessionId), sessionId, &bytesUsed);

            if (SUCCEEDED(hr)) {
                // Game logic to use session id
            }
            else if (hr == E_GAMESTREAMING_NO_DATA) {
                // Game logic to handle no data for client
            }
            else
            {
                // Default error case
                LogFormat(L"XGameStreamingGetSessionId failed %x", hr);
            }

            break;
        }

        default:
            // A characteristic we are not tracking - do nothing
            break;
        }
    }
}

```

## 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](/fr-CA/reference/system/xgamestreaming/xgamestreaming_members)
[XGameStreamingRegisterClientPropertiesChanged](/fr-CA/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged)


## Related topics

- [XGameStreamingGetSessionId](/reference/system/xgamestreaming/functions/xgamestreaminggetsessionid.md)
- [XGameStreamingClientProperty](/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md)
- [XGameStreaming](/reference/system/xgamestreaming/xgamestreaming_members.md)