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

Esta API devuelve una cadena opaca terminada en null que identifica de forma única la sesión de streaming del cliente especificado.

## Sintaxis

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

### Parámetros

*client*   \_In\_\
Tipo: XGameStreamingClientId

El cliente de streaming que se está consultando.

*sessionIdSize*   \_In\_\
Tipo: size\_t

El tamaño del búfer `sessionId`.

*sessionId*   \_Out\_writes\_bytes\_to\_(sessionIdSize, \*sessionIdUsed)\
Tipo: char\*

El búfer que se rellenará con el identificador de sesión del cliente especificado.

*sessionIdUsed*   \_Out\_opt\_\
Tipo: size\_t\*

El tamaño en bytes del valor devuelto en el búfer `sessionId` (incluido el terminador nulo).

### Valor devuelto

Tipo: HRESULT

Devuelve **S\_OK** si se realiza correctamente; de lo contrario, devuelve un código de error.

#### Posibles errores

| Código de error                          | Valor de error | Motivo del error                                                                                                                                                                                      |
| ---------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| E\_GAMESTREAMING\_NOT\_INITIALIZED       | 0x89245400     | El entorno de ejecución de XGameStreaming no se ha inicializado. Llame a [XGameStreamingInitialize](/reference/system/xgamestreaming/functions/xgamestreaminginitialize) antes de llamar a otras API. |
| E\_GAMESTREAMING\_CLIENT\_NOT\_CONNECTED | 0x89245401     | El cliente especificado no está conectado.                                                                                                                                                            |
| E\_GAMESTREAMING\_NO\_DATA               | 0x89245402     | Los datos solicitados no están disponibles. Es posible que los datos estén disponibles más adelante.                                                                                                  |
| E\_NOT\_SUFFICIENT\_BUFFER               | 0x7A           | *sessionId* no es lo suficientemente grande como para contener el identificador de sesión y el carácter nulo de terminación.                                                                          |

Para obtener una lista de códigos de error, consulte [Códigos de error](/reference/errorcodes).

## Comentarios

La cadena escrita en `sessionId` nunca será mayor que `SessionIdMaxBytes`, por lo que se puede asignar previamente. La estructura o el contenido de un `sessionId` puede cambiar en el futuro y, por tanto, solo debe interpretarse como una cadena opaca. Al igual que con otras API de propiedades de cliente, se recomienda usar `XGameStreamingRegisterClientPropertiesChanged` para registrar una devolución de llamada para los cambios en el `sessionId`.

## Ejemplo

```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;
        }
    }
}

```

## Requisitos

**Encabezado:** xgamestreaming.h\
**Biblioteca:** xgameruntime.lib\
**Plataformas compatibles:** Windows, consolas de la familia XBOX One y consolas XBOX Series

## Consulte también

[XGameStreaming](/reference/system/xgamestreaming/xgamestreaming_members)
[XGameStreamingRegisterClientPropertiesChanged](/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged)


## Related topics

- [XGameStreamingClientProperty](/es/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md)
- [XGameStreaming](/es/reference/system/xgamestreaming/xgamestreaming_members.md)
- [Contenedores de API de C# de Unity para el GDK](/es/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XGameStreamingGetClients](/es/reference/system/xgamestreaming/functions/xgamestreaminggetclients.md)
- [XGameStreamingGetConnectionState](/es/reference/system/xgamestreaming/functions/xgamestreaminggetconnectionstate.md)