XUserGetLocalId

项目
05/09/2023

检索用户的唯一游戏会话 ID。

语法

HRESULT XUserGetLocalId(  
         XUserHandle user,  
         XUserLocalId* userLocalId  
)

参数

user _In_
类型：XUserHandle

要检索其本地 ID 的用户句柄。

userLocalId _Out_
类型：XUserLocalId*

包含用户的唯一游戏会话 ID。

返回值

类型：HRESULT

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

备注

要检索特定用户的用户 ID，请调用 XUserGetId。

要检索特定用户的状态，请调用 XUserGetState。

要检索特定用户的年龄组，请调用 XUserGetAgeGroup。

XUserLocalId 唯一标识游戏会话内的用户。如果复制 XUserHandle，则这两个句柄将维持相同的 XUserLocalId。一旦游戏会话结束，同一用户在下一会话期间可能具有不同的 XUserLocalId。请勿使用这些 ID 来跟踪跨游戏会话的用户。

下面的示例演示如何使用 XUserLocalId 检索用户的默认音频终结点。

HRESULT GetAudioDeviceAssociation(
    IMMDeviceEnumerator* audioDeviceEnumerator,
    XUserLocalId user,
    XUserDefaultAudioEndpointKind defaultAudioEndpointKind,
    _Outptr_result_maybenull_ IMMDevice** endpoint)
{
    wchar_t audioDeviceId[XUserAudioEndpointMaxUtf16Count];
    RETURN_IF_FAILED_WITH_EXPECTED(XUserGetDefaultAudioEndpointUtf16(user, defaultAudioEndpointKind, std::size(audioDeviceId), audioDeviceId, nullptr), E_NOTFOUND);

    return audioDeviceEnumerator->GetDevice(audioDeviceId, endpoint);
}

HRESULT GetAudioAssociations()
{
    Mwrl::ComPtr<IMMDeviceEnumerator> audioDeviceEnumerator;

    RETURN_IF_FAILED(CoCreateInstance(
        __uuidof(MMDeviceEnumerator),
        nullptr,
        CLSCTX_ALL,
        __uuidof(IMMDeviceEnumerator),
        (void**)&audioDeviceEnumerator));

    XUserLocalId userLocalId;
    RETURN_IF_FAILED(XUserGetLocalId(_handle.get(), &userLocalId));

    {
        wil::unique_cotaskmem_string id;
        Mwrl::ComPtr<IMMDevice> device;
        if (SUCCEEDED(GetAudioDeviceAssociation(audioDeviceEnumerator.Get(), userLocalId, XUserDefaultAudioEndpointKind::CommunicationRender, &device)))
        {
            RETURN_IF_FAILED(device->GetId(&id));
        }
        appLog.AddLog("Preferred render communication device id: %S\n", id.get());
    }

    {
        wil::unique_cotaskmem_string id;
        Mwrl::ComPtr<IMMDevice> device;
        if (SUCCEEDED(GetAudioDeviceAssociation(audioDeviceEnumerator.Get(), userLocalId, XUserDefaultAudioEndpointKind::CommunicationCapture, &device)))
        {
            RETURN_IF_FAILED(device->GetId(&id));
        }
        appLog.AddLog("Preferred capture communication device id: %S\n", id.get());
    }

    return S_OK;
}