> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XUserGetLocalId

> XUserGetLocalId

# XUserGetLocalId

Recupera uma ID de sessão de jogo exclusiva para um usuário.

## Sintaxe

```cpp theme={null}
HRESULT XUserGetLocalId(  
         XUserHandle user,  
         XUserLocalId* userLocalId  
)  
```

### Parâmetros

*user*   \_In\_\
Tipo: XUserHandle

Um identificador para o usuário cuja ID local será recuperada.

*userLocalId*   \_Out\_\
Tipo: [XUserLocalId\*](/pt-BR/reference/system/xuser/structs/xuserlocalid)

Contém uma ID de sessão de jogo exclusiva para um usuário.

### Valor retornado

Tipo: HRESULT

Código de sucesso ou erro HRESULT.\
Para obter uma lista de códigos de erro, consulte [Códigos de erro](/pt-BR/reference/errorcodes).

## Comentários

Para recuperar a ID de usuário de um usuário específico, chame [XUserGetId](/pt-BR/reference/system/xuser/functions/xusergetid).

Para recuperar o estado de um usuário específico, chame [XUserGetState](/pt-BR/reference/system/xuser/functions/xusergetstate).

Para recuperar a faixa etária de um usuário específico, chame [XUserGetAgeGroup](/pt-BR/reference/system/xuser/functions/xusergetagegroup).

O **XUserLocalId** identifica exclusivamente um usuário em uma sessão de jogo. Se você duplicar o **XUserHandle**, ambos os identificadores manterão o mesmo **XUserLocalId**. Quando a sessão de jogo terminar, o mesmo usuário poderá ter um **XUserLocalId** diferente durante a próxima sessão. Não use essas IDs para rastrear usuários entre sessões de jogo.

O exemplo a seguir demonstra como usar o **XUserLocalId** para recuperar o ponto de extremidade de áudio padrão de um usuário.

```cpp theme={null}
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;
}
```

## Requisitos

**Cabeçalho:** XUser.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, Steam Deck, consoles da família XBOX One e consoles XBOX Series

## Confira também

[XUser](/pt-BR/reference/system/xuser/xuser_members)

[XUserGetId](/pt-BR/reference/system/xuser/functions/xusergetid)

[XUserGetState](/pt-BR/reference/system/xuser/functions/xusergetstate)

[XUserGetAgeGroup](/pt-BR/reference/system/xuser/functions/xusergetagegroup)


## Related topics

- [XUserGetLocalId](/reference/system/xuser/functions/xusergetlocalid.md)
- [XUserLocalId](/reference/system/xuser/structs/xuserlocalid.md)
