XStoreShowGiftingUIAsync

开始 UI 覆盖,以购买指定产品作为另一用户的礼物。 系统将提示当前用户输入有关礼品接收者的信息,并引导用户完成购买流程。

语法

HRESULT XStoreShowGiftingUIAsync(  
         const XStoreContextHandle storeContextHandle,  
         const char* storeId,  
         const char* name,  
         const char* extendedJsonData,  
         XAsyncBlock* async  
)  

参数

storeContextHandle _In_
类型:XStoreContextHandle

XStoreCreateContext 返回的用户的应用商店上下文句柄。

storeId _In_z_
类型:char*

要作为礼物购买的产品的 ID。 注意:此产品必须配置为支持礼品购买。

name _In_opt_z_
类型:char*

要作为礼品购买的产品的名称。

extendedJsonData _In_opt_z_
类型:char*

传递给购买礼品流的 json Blob。 允许插入自定义市场活动 ID,以便您可以跟踪如何启动购买。

async _Inout_
类型:XAsyncBlock*

用于定义正在进行的异步工作的 XAsyncBlockXAsyncBlock 可用于轮询调用的状态和检索调用结果。 有关详细信息,请参阅 XAsyncBlock

返回值

类型:HRESULT

HRESULT 成功或错误代码。

备注

要作为礼品购买的产品必须配置为支持礼品购买。 若要检索支持送礼的产品列表,请调用将 参数设置为 "Gift"actionFiltersXStoreQueryProductsAsync

若要检索此函数的结果,在调用此函数后调用 XStoreShowGiftingUIResult 。 仅当用户选择将商品作为礼物购买时,才应调用此函数,并且将导致系统显示处理付款信息和用户确认的模式购买对话框。

以下代码片段演示了为特定商店产品请求礼品购买的示例。

void CALLBACK ShowGiftingUICallback(XAsyncBlock* asyncBlock)
{
    HRESULT hr = XStoreShowGiftingUIResult(asyncBlock);

    if (FAILED(hr))
    {
        printf("Failed the gift purchase: 0x%x\r\n", hr);
        return;
    }
}

void ShowGiftingUI(XStoreContextHandle storeContextHandle, XTaskQueueHandle taskQueueHandle, const char* storeId)
{
    auto asyncBlock = std::make_unique<XAsyncBlock>();
    ZeroMemory(asyncBlock.get(), sizeof(*asyncBlock));
    asyncBlock->queue = taskQueueHandle;
    asyncBlock->callback = ShowGiftingUICallback;

    HRESULT hr = XStoreShowGiftingUIAsync(
        storeContextHandle,
        storeId,
        nullptr,    // Can be used to override the title bar text
        nullptr,    // Can be used to provide extra details to purchase
        asyncBlock.get());

    if (FAILED(hr))
    {
        printf("Failed to purchase: 0x%x\r\n", hr);
        return;
    }
}


要求

头文件:XStore.h(包含在 XGameRuntime.h 中)

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XStore
XStoreShowGiftingUIResult