> ## 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.

# XPackageGetUserLocale

> XPackageGetUserLocale

# XPackageGetUserLocale

Obtém a localidade atual do usuário.

<a id="syntaxSection" />

## Sintaxe

```cpp theme={null}
HRESULT XPackageGetUserLocale(
    size_t localeSize,
    char* locale
)  
```

<a id="parametersSection" />

### Parâmetros

*localeSize*   \_In\_\
Tipo: size\_t

Em caso de sucesso, o tamanho da cadeia de caracteres em *locale*.

*locale*   \_Out\_writes\_(localeSize)\
Tipo: char\*

Em caso de sucesso, contém a localidade do usuário.

<a id="retvalSection" />

### Valor retornado

Tipo: HRESULT

Código de sucesso ou de erro HRESULT.

<a id="remarksSection" />

## Comentários

<Note>Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, consulte [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Essa função obtém a localidade do usuário que mais se aproxima da localidade do pacote. Se nenhuma informação de localidade for declarada para o pacote, essa função terá êxito, mas não retornará uma localidade do usuário em `locale`. Se a localidade do pacote corresponder a uma localidade de usuário instalada, a função terá êxito e retornará a localidade do usuário em `locale`. Se a localidade do pacote não corresponder exatamente a uma localidade de usuário instalada, a função tentará localizar a localidade de usuário instalada mais próxima. Se a função não conseguir encontrar uma correspondência próxima, ocorrerá um erro; caso contrário, a função terá êxito e a localidade de usuário instalada mais próxima será retornada em `locale`.

Se você estiver usando a Intelligent Delivery para controlar quais idiomas são instalados para seu jogo, é possível que a localidade definida pelo usuário no console tenha partes que não estão instaladas no momento. Isso exige que um jogo sempre verifique se as partes necessárias estão instaladas e recorra a outro idioma caso não estejam: um procedimento que exige um conhecimento considerável sobre localidades e como elas recorrem aos idiomas mais próximos. Essa função fornece uma maneira de obter a localidade atual do usuário, ou a alternativa correspondente mais próxima, sem a necessidade de implementar sua própria análise de localidade e procedimento de fallback.

O exemplo de código a seguir demonstra como usar essa função.

```cpp theme={null}
char gameLocale[LOCALE_NAME_MAX_LENGTH];

// Get the best user locale that is installed
HRESULT hr = XPackageGetUserLocale(_countof(gameLocale), gameLocale);
if (SUCCEEDED(hr))
{
    printf("Game using locale: %s\n", gameLocale);
}
```

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** XPackage.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatíveis:** Windows, consoles da família XBOX One e consoles XBOX Series

<a id="seealsoSection" />

## Documentação conceitual

* [Intelligent Delivery: especificadores de idioma](/pt-BR/build/core-features/common/packaging/intelligentdelivery-language)
* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [Determinando a localidade e o idioma do console](/pt-BR/build/game-principles/localization/determining-console-locale)

## Confira também

[XPackage](/pt-BR/reference/system/xpackage/xpackage_members)\
[Instalação por streaming e Intelligent Delivery](/pt-BR/build/core-features/common/packaging/overviews/streaming_install-intelligent_delivery)


## Related topics

- [XPackageGetUserLocale](/reference/system/xpackage/functions/xpackagegetuserlocale.md)
- [Determining console locale and language](/build/game-principles/localization/determining-console-locale.md)
- [Localization and globalization overview](/build/game-principles/localization.md)
- [Determinación de la configuración regional y el idioma de la consola](/es/build/game-principles/localization/determining-console-locale.md)
- [确定主机区域设置与语言](/zh-CN/build/game-principles/localization/determining-console-locale.md)