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

# XtfGetTitleOSState

> XtfGetTitleOSState

# XtfGetTitleOSState

Obtém informações sobre o jogo em execução, incluindo seu estado, ID do processo, nome completo do pacote e AUMIDs (Application User Model IDs).

<a id="syntaxSection" />

## Sintaxe

```cpp theme={null}
HRESULT XtfGetTitleOSState(
        PCWSTR address,
        UINT32* titleStateFlags,
        UINT32* pid,
        PWSTR packageFullName,
        UINT32* packageFullNameLength,
        PWSTR aumid,
        UINT32* aumidLength)
```

<a id="parametersSection" />

### Parâmetros

*address*\
Tipo: PCWSTR

\[in] O endereço do console.

*titleStateFlags*\
Tipo: UINT32\*

\[out, optional] Uma combinação OR bit a bit de sinalizadores que fornecem informações adicionais sobre o jogo. Se esse valor não for necessário, defina-o como `nullptr`. Esse parâmetro dá suporte aos seguintes sinalizadores:

| Sinalizador | Valor | Descrição |
| - | - | - |
| XTF\_TITLESTATE\_FASTITERATION\_ENABLED | 0x0001 | O Modo de Iteração Rápida está habilitado para esse jogo. Para obter mais informações sobre o Modo de Iteração Rápida, confira [Gerenciamento de aplicativos (xbapp.exe) (tópico sob NDA)](/pt-BR/tools/tools-console/commandlinetools/xbapp) e [Gerenciamento de aplicativos e arquivos (tópico sob NDA)](/pt-BR/tools/tools-console/xbom/manager-tool-managing-applications). |
| XTF\_TITLESTATE\_TITLE\_RUNNING | 0x0002 | O jogo está em execução no momento. |
| XTF\_TITLESTATE\_TITLEOS\_RUNNING | 0x0004 | O Game OS do jogo está em execução no momento. |
| XTF\_TITLESTATE\_TITLENETWORK\_READY | 0x0008 | A rede está pronta para o jogo. |

*pid*\
Tipo: UINT32\*

\[out, optional] O ID do processo do jogo, se o jogo estiver em execução no momento; caso contrário, zero. Se esse valor não for necessário, defina-o como `nullptr`.

*packageFullName*\
Tipo: PWSTR

\[out, optional] O nome completo do pacote do jogo, se o jogo estiver em execução no momento; caso contrário, uma cadeia de caracteres vazia (""). Se esse valor não for necessário ou se o comprimento do buffer for necessário, defina-o como `nullptr`.

*packageFullNameLength*\
Tipo: UINT32\*

\[out, optional] O comprimento do buffer necessário para *packageFullName* em WCHAR. Se esse valor não for necessário, defina-o como `nullptr`.

*aumid*\
Tipo: PWSTR

\[out, optional] A AUMID do jogo, se o jogo estiver em execução no momento; caso contrário, uma cadeia de caracteres vazia (""). Se esse valor não for necessário, defina-o como `nullptr`.

*aumidLength*\
Tipo: UINT32\*

\[out, optional] O comprimento do buffer necessário para *aumid* em WCHAR. Se esse valor não for necessário, defina-o como `nullptr`.

<a id="retvalSection" />

### Valor retornado

Tipo: HRESULT

Retorna `S_OK` se for bem-sucedido; caso contrário, retorna um código de erro HRESULT. Retorna `HRESULT_FROM_WIN32(ERROR_MORE_DATA)` se os buffers `packageFullName` ou `aumid` forem muito pequenos.

<a id="remarksSection" />

## Comentários

Essa função retorna informações sobre o estado do jogo em execução no momento, incluindo sinalizadores de estado do título, ID do processo, nome completo do pacote e AUMID (Application User Model ID). Para obter mais informações sobre empacotamento, confira [Empacotamento](/pt-BR/build/core-features/common/packaging/gc-packaging-toc).

Para recuperar os comprimentos de buffer necessários para os buffers `packageFullName` e `aumid`, execute as seguintes etapas:

1. Defina os parâmetros `packageFullName` e `aumid` como `nullptr`
2. Defina os parâmetros `packageFullNameLength` e `aumidLength` como ponteiros UINT32 válidos
3. Chame `XtfGetTitleOSState`

Se a função for executada com êxito, os parâmetros `packageFullNameLength` e `aumidLength` conterão os comprimentos de buffer necessários, em WCHAR, para `packageFullName` e `aumidLength`, respectivamente.

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

<a id="seealsoSection" />

## Confira também

[XtfGetAumid](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m)\
[XtfGetPackageFullName](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m)\
[Erros de transporte do XTF (tópico sob NDA)](/pt-BR/tools/tools-console/commandlinetools/xtf-transport-errors)\
[APIs adicionais do Xtf](/pt-BR/reference/tools/xtf/xtfapi/atoc-xtfapi)


## Related topics

- [XtfWaitForConsoleState](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md)
- [XtfGetCachedTitleOSVersions](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md)
- [XtfGetCachedTitleOSVersionsCallback](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md)
- [XtfGetTitleOSFourPartVersion](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md)
- [XtfGetTitleProcessMemoryReports](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md)