ターゲット URL への HTTPS 呼び出しを承認するために必要な X トークンと署名を非同期的に取得する API。 これにより、パートナー センターのタイトルの [シングル サインオン]認可が必須です ページにターゲット URL に関連付けられている証明書利用者がある場合、X トークンと署名が返されます。 要求を行う前に、Results バージョンの API から HTTPS 呼び出しの Authorization ヘッダーと Signature ヘッダーに X トークンと Signature の値を追加します。
構文
HRESULT XUserGetTokenAndSignatureUtf16Async(
XUserHandle user,
XUserGetTokenAndSignatureOptions options,
const wchar_t* method,
const wchar_t* url,
size_t headerCount,
const XUserGetTokenAndSignatureUtf16HttpHeader* headers,
size_t bodySize,
const void* bodyBuffer,
XAsyncBlock* async
)
パラメーター
user _In_
型: XUserHandle
Web 要求の対象となるユーザーに対するハンドル。
options _In_
型: XUserGetTokenAndSignatureOptions
ユーザー トークンと署名を取得するためのオプション。
メソッド _In_z_
型: wchar_t*
Web 要求のメソッドの種類 (Unicode)。
url _In_z_
型: wchar_t*
HTTPS 要求のターゲット URL。 HTTPS 要求には完全な URL 文字列を使用します。 URL を省略しないでください。
headerCount_In_
型: size_t
headers パラメーター内のヘッダー数。
headers_In_reads_opt_(headerCount)
型: XUserGetTokenAndSignatureUtf16HttpHeader*
Web 要求のヘッダー。
bodySize _In_
型: size_t
bodyBuffer パラメーター内のバッファーのサイズ。
bodyBuffer_In_reads_bytes_opt_(bodySize)
型: void*
Web 要求の本文が格納されるバッファー。
async _Inout_
型: XAsyncBlock*
XAsyncBlock は、呼び出しのステータスをポーリングし、呼び出しの結果を取得します。
戻り値
型: HRESULT
成功した場合は S_OK を返し、それ以外の場合はエラー コードを返します。 エラー コードの一覧については、「エラー コード」を参照してください。
解説
XUserGetTokenAndSignatureUtf16Async 関数は、XUserGetTokenAndSignatureOptions 列挙型引数を使用して Web 要求の Unicode の Xtoken と署名を非同期に取得します。
XUserGetTokenAndSignatureUtf16Async の呼び出しの結果を取得するには、XUserGetTokenAndSignatureUtf16Result を呼び出します。
XUserGetTokenAndSignatureUtf16Async の呼び出し結果を保持するために必要なバッファー サイズを取得するには、XUserGetTokenAndSignatureUtf16ResultSize を呼び出します。
要件
ヘッダー: XUser.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Steam Deck、Xbox One ファミリ本体、Xbox Series 本体