XUserRegisterForChangeEvent

项目
05/09/2023

注册用户更改事件的回调。

语法

HRESULT XUserRegisterForChangeEvent(  
         XTaskQueueHandle queue,  
         void* context,  
         XUserChangeEventCallback* callback,  
         XTaskQueueRegistrationToken* token  
)

参数

queue _In_opt_
类型：XTaskQueueHandle

要在其上执行操作的异步队列句柄。

context _In_opt_
类型：void*

要传递给回调的用户定义的上下文。

callback _In_
类型：XUserChangeEventCallback*

要注册的用户定义的回调。

token _Out_
类型：XTaskQueueRegistrationToken*

包含标识注册的回调的令牌。使用此令牌取消注册回调。

返回值

类型：HRESULT

HRESULT 成功或错误代码。
有关错误代码的列表，请参阅错误代码。

备注

注意

在时间敏感线程上调用此函数是不安全的。有关详细信息，请参阅时间敏感线程。

XUserChangeEvent 枚举指定更改事件类型。 XUserChangeEventCallback 是用户更改事件的回调。

要取消注册之前注册的用户更改回调，请调用 XUserUnregisterForChangeEvent。

以下示例演示了如何处理用户更改事件。

HRESULT RegisterForChanges()
{
    RETURN_HR_IF(E_UNEXPECTED, _token.token != 0);
    RETURN_IF_FAILED(XUserRegisterForChangeEvent(
        _queue,
        this,
        UserChangeEventHandler,
        &_token));
    return S_OK;
}

void UnregisterForChanges()
{
    XUserUnregisterForChangeEvent(_token, false);
    _token.token = 0;
}

void UserChangeEventHandler(
    XUserLocalId userLocalId,
    XUserChangeEvent event)
{
    auto iter = std::find_if(
        _users.begin(),
        _users.end(),
        [&userLocalId](const User& candidate)
    {
        XUserLocalId candidateUserLocalId;
        XUserGetLocalId(candidate.Handle(), &candidateUserLocalId);
        return candidateUserLocalId == userLocalId;
    });

    // User not known
    if (iter == _users.end())
    {
        return;
    }

    auto handle = iter->Handle();

    // If a guest gets signed out, immediately close the handle
    bool isGuest;
    if (SUCCEEDED_LOG(XUserGetIsGuest(handle, &isGuest)) &&
        isGuest &&
        event == XUserChangeEvent::SignedOut)
    {
        _users.erase(iter);
    }

    if (event == XUserChangeEvent::SigningOut)
    {
        // Delay the user signing out just for fun
        XUserSignOutDeferralHandle deferral;
        if (SUCCEEDED_LOG(XUserGetSignOutDeferral(&deferral)))
        {
            // Hold the deferral for 5 seconds then close it
            std::thread completeDeferralThread(
                [deferral]()
            {
                std::this_thread::sleep_for(std::chrono::milliseconds(5000));
                XUserCloseSignOutDeferralHandle(deferral);
            });

            completeDeferralThread.detach();
        }
    }

    if (event == XUserChangeEvent::GamerPicture)
    {
        iter->LoadGamerPicAsync(_queue);
    }
}