XUserGetTokenAndSignatureResult

XUserGetTokenAndSignatureAsync の呼び出しの結果を取得します。

構文

HRESULT XUserGetTokenAndSignatureResult(  
         XAsyncBlock* async,  
         size_t bufferSize,  
         void* buffer,  
         XUserGetTokenAndSignatureData** ptrToBuffer,  
         size_t* bufferUsed  
)  

パラメーター

async _Inout_
型: XAsyncBlock*

XAsyncBlock は、呼び出しのステータスをポーリングし、呼び出しの結果を取得します。

bufferSize _In_
型: size_t

buffer パラメーターのバッファーのサイズ。

buffer _Out_writes_bytes_to_(bufferSize,bufferUsed)
型: void

XUserGetTokenAndSignatureAsync の呼び出しの結果が格納されます。

ptrToBuffer _Outptr_
型: XUserGetTokenAndSignatureData**

戻ったとき、prtToBuffer は buffer パラメーターに指定したバッファーを指します。 パラメーターでは、buffer に対する型指定されたポインターを提供し、個別に開放する必要はありません。

bufferUsed_Out_opt_
型: size_t*

buffer パラメーターに書き込まれたバイト数。

戻り値

型: HRESULT

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

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

解説

Web 要求のX トークンと署名を非同期に取得するには、XUserGetTokenAndSignatureAsync を呼び出します。

XUserGetTokenAndSignatureAsync の呼び出し結果を保持するために必要なバッファー サイズを取得するには、XUserGetTokenAndSignatureResultSize を呼び出します。

次の例は、ユーザーのトークンと署名を非同期で取得する方法を示しています。

HRESULT RequestTokenComplete(XAsyncBlock* abResult)
{
    size_t bufferSize;
    RETURN_IF_FAILED(XUserGetTokenAndSignatureResultSize(abResult, &bufferSize));

    std::vector<uint8_t> buffer(bufferSize);
    XUserGetTokenAndSignatureData* data;
    if (SUCCEEDED_LOG(XUserGetTokenAndSignatureResult(abResult, buffer.size(), buffer.data(), &data, nullptr /*bufferUsed*/)))
    {
        appLog.AddLog("Token: %s\n", data->token);
        if (data->signature != nullptr)
        {    
            appLog.AddLog("Signature: %s\n", data->signature);
        }
    }

    return S_OK;
}

HRESULT RequestTokenAsync(
    XTaskQueueHandle queue,
    const char* url,
    bool forceRefresh)
{
    auto asyncBlock = std::make_unique<XAsyncBlock>();
    ZeroMemory(asyncBlock.get(), sizeof(*asyncBlock));
    asyncBlock->queue = queue;
    asyncBlock->context = this;
    asyncBlock->callback = [](XAsyncBlock* ab)
    {
        LOG_IF_FAILED(static_cast<User*>(ab->context)->RequestTokenComplete(ab));
        delete ab;
    };


    XUserGetTokenAndSignatureOptions options = XUserGetTokenAndSignatureOptions::None;

    if (forceRefresh)
    {
        WI_SET_FLAG(options, XUserGetTokenAndSignatureOptions::ForceRefresh);
    }

    static const XUserGetTokenAndSignatureHttpHeader headers[] =
    {
        { "Accept", "application/json"},
        { "Why", "Because"},
    };

    if (SUCCEEDED_LOG(XUserGetTokenAndSignatureAsync(
        _handle.get(),
        options,
        "GET",
        url,
        ARRAYSIZE(headers),
        headers,
        0,
        nullptr,
        asyncBlock.get())))
    {
        // The call succeeded, so release the std::unique_ptr ownership of XAsyncBlock* since the callback will take over ownership.
        // If the call fails, the std::unique_ptr will keep ownership and delete the XAsyncBlock*
        asyncBlock.release();
    }

    return S_OK;
}

要件

ヘッダー: XUser.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Steam Deck、Xbox One ファミリ本体、Xbox Series 本体

関連項目

XUser

XUserGetTokenAndSignatureAsync

XUserGetTokenAndSignatureResultSize