XGameStreamingGetSessionId

この API は、指定されたクライアントのストリーミング セッションを一意に識別する null 値で終わる不透明な文字列を返します。

構文

HRESULT XGameStreamingGetSessionId(
        XGameStreamingClientId client,
        size_t sessionIdSize,
        char* sessionId,
        size_t* sessionIdUsed
)

パラメーター

client _In_
型: XGameStreamingClientId

クエリされているストリーミング クライアント デバイス。

sessionIdSize _In_
型: size_t

sessionId バッファーのサイズ。

sessionId _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
型: char*

指定されたクライアントのセッション IP が設定されるバッファー。

sessionIdUsed _Out_opt_
型: size_t*

sessionId バッファーで返される値のサイズ (バイト単位)。(Null ターミネータを含む)。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合はエラー コードを返します。

返される可能性のあるエラー

エラー コード	エラー値	エラーの原因
E_GAMESTREAMING_NOT_INITIALIZED	0x89245400	XGameStreaming ランタイムが初期化されていません。 他の API を呼び出す前に XGameStreamingInitialize を呼び出してください。
E_GAMESTREAMING_CLIENT_NOT_CONNECTED	0x89245401	指定されたクライアントが接続されていません。
E_GAMESTREAMING_NO_DATA	0x89245402	要求されたデータは利用できません。 データは後で利用可能になる場合があります。
E_NOT_SUFFICIENT_BUFFER	0x7A	sessionId は、セッション ID と null 終端文字を保持するのに十分な大きさではありません。

エラー コードの一覧については、「エラー コード」を参照してください。

解説

sessionId に書き込まれた文字列は、SessionIdMaxBytes より大きくなることはありません。そのため、事前に割り当てることができます。 sessionId のレイアウト/内容は後で変更される可能性があるため、不透明な文字列としてのみ解釈する必要があります。 他のクライアント プロパティ API と同様に、XGameStreamingRegisterClientPropertiesChanged を使用して、sessionId への変更のコールバックを登録することをお勧めします。

例

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

要件

ヘッダー: xgamestreaming.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameStreamingXGameStreamingRegisterClientPropertiesChanged