Skip to main content

XGameStreamingGetSessionId

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

Syntax

Parameters

client   _In_
型: XGameStreamingClientId
照会するストリーミング クライアント。 sessionIdSize   _In_
型: size_t
sessionId バッファーのサイズ。 sessionId   _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
型: char*
指定されたクライアントのセッション ID が格納されるバッファー。 sessionIdUsed   _Out_opt_
型: size_t*
sessionId バッファーに返される値のバイト単位のサイズ (null 終端文字を含む)。

Return value

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

想定されるエラー

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

Remarks

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

Example

Requirements

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

See also

XGameStreaming XGameStreamingRegisterClientPropertiesChanged
最終更新日 2026年8月24日