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

# APIs adicionais do Xtf (conteúdo da API)

> APIs adicionais do Xtf

# APIs adicionais do Xtf

A API do XBOX Tools Framework (XTF) é usada para verificar o espaço disponível para aplicativos e recuperar mensagens de erro amigáveis.

## Funções de aplicativo

| Função de aplicativo | Descrição |
| - | - |
| [XtfPullAuditionApp](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m.md) | Reservado para uso interno. |
| [XtfPullRegisterApp](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m.md) | Reservado para uso interno. |
| [XtfPullSupplyMock](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m.md) | Reservado para uso interno. |
| [XtfPullUnregisterApp](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m.md) | Reservado para uso interno. |

## Funções de informações do console

| Função de informações do console | Descrição |
| - | - |
| [XtfCloseConsoleInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) | Libera os recursos associados a um objeto **XtfConsoleInfo** retornado por XtfGetConsoleInfoList. |
| [XtfGetAvailableSpaceForAppInstallation](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m.md) | Obtém o número total de bytes disponíveis no dispositivo de armazenamento especificado de um console de desenvolvimento. |
| [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) | Recupera informações sobre um console: Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion. |
| [XtfGetConsoleInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m.md) | Retorna um objeto `XtfConsoleInfo` que contém informações sobre um console. |
| [XtfGetSavedConsoleAddress](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m.md) | Obtém o endereço IP de ferramentas do console padrão para aplicativos do XBOX Tools Framework (XTF). |
| [XtfGetSystemUpTime](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m.md) | Obtém o tempo, em milissegundos, durante o qual o System OS e o Game OS estão em execução. |
| [XtfWaitForConsoleOSReady](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m.md) | Aguarda até que o sistema operacional do console esteja pronto para receber comandos antes de retornar. |
| [XtfWaitForConsoleState](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md) | Bloqueia a execução até que os estados de console especificados sejam alcançados ou ocorra um tempo limite. |

## Funções de credencial

| Função de credencial | Descrição |
| - | - |
| [XtfAddCredential](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md) | Adiciona credenciais (nome de usuário e senha) ao console especificado para uso pela Implantação Executar a partir do PC. |
| [XtfCloseCredentialInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md) | Libera os recursos associados a um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfGetCredentialInfoCount](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md) | Obtém a contagem de credenciais armazenadas em um objeto `XtfNetworkCredentials` retornado por [XtfGetCredentialInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md). |
| [XtfGetCredentialInfoList](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) | Retorna um objeto `XtfNetworkCredentials` que contém a lista de credenciais armazenadas atualmente no console. |
| [XtfGetCredentialServerName](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m.md) | Obtém a parte do nome do servidor das credenciais armazenadas em um índice de um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfGetCredentialUserName](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m.md) | Obtém a parte do nome de usuário das credenciais armazenadas em um índice de um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfRemoveCredential](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m.md) | Remove credenciais do console especificado. Use XtfAddCredential para adicionar credenciais. |

## Funções de depuração

| Função de depuração | Descrição |
| - | - |
| [XtfCaptureOutputBegin](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) | Inicia a captura da saída de depuração. |
| [XtfCaptureOutputEnd](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m.md) | Interrompe a captura da saída de depuração. |
| [XtfDebugStringCallback](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m.md) | Retorno de chamada invocado para cada cadeia de caracteres de saída de depuração capturada por [XtfCaptureOutputBegin](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md). |
| [XtfDebugStringErrorCallback](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m.md) | Retorno de chamada invocado para cada erro capturado por [XtfCaptureOutputBegin](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md). |
| [XtfGetErrorText](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m.md) | Obtém uma mensagem de erro amigável e o texto de ação para o `HRESULT` especificado. |

## Funções de clipe de jogo

| Função de clipe de jogo | Descrição |
| - | - |
| [XtfCaptureRecordedGameClip](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md) | Captura um clipe de vídeo do jogo em execução no momento. |

## Funções de informações do pacote

| Função de informações do pacote | Descrição |
| - | - |
| [XtfClosePackageInfo](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m.md) | Libera um objeto de informações do pacote. |
| [XtfGetAumid](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m.md) | Obtém a ID do modelo de usuário do aplicativo em um índice de um objeto de informações do pacote. |
| [XtfGetCountofAppUserModelIds](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m.md) | Obtém a contagem de IDs de modelo de usuário do aplicativo de um objeto de informações do pacote. |
| [XtfGetPackageFullName](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m.md) | Obtém o nome completo do pacote de um objeto de informações do pacote. |
| [XtfRegisterAllPackagesOnDrive](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m.md) | Registra todos os pacotes implantados na unidade especificada. |
| [XtfRegisterNetworkSharePackage](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m.md) | Registra um pacote para a Implantação Executar a partir do PC. |
| [XtfRegisterPackage](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md) | Registra um pacote implantado na unidade de rascunho do título. |
| [XtfRegisterPackageOnDrive](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m.md) | Registra um pacote implantado na unidade especificada. |
| [XtfUnregisterPackage](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m.md) | Cancela o registro de um pacote implantado na unidade de rascunho do título. |

## Funções do Title OS

| Função do Title OS | Descrição |
| - | - |
| [XtfCacheTitleOS](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md) | Adiciona um Game OS ao cache do sistema operacional. |
| [XtfGetCachedTitleOSVersions](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) | Obtém as informações de versão de cada Game OS armazenado em cache no console. |
| [XtfGetCachedTitleOSVersionsCallback](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md) | Retorno de chamada invocado para cada Game OS encontrado por [XtfGetCachedTitleOSVersions](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md). |
| [XtfGetTitleOSFourPartVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md) | Obtém informações de versão sobre o Game OS do título em execução no momento. |
| [XtfGetTitleOSState](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m.md) | Consulta o estado do Title OS, do Modo de Iteração Rápida, do título em execução, do PID associado e das informações do pacote. |
| [XtfGetTitleProcessMemoryReports](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md) | Reservado para uso interno. |
| [XtfRemoveTitleOSFromCache](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m.md) | Remove um Game OS do cache no console. |
| [XtfRemoveTitleOSFromCacheByVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m.md) | Remove do cache no console o Game OS que corresponde à [FourPartVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) especificada. |
| [XtfShutdownTitleOS](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md) | Desliga o título ativo e o Game OS. |
| [XtfStartTitleOS](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md) | Inicia ou reinicia o Game OS especificado. |
| [XtfStartTitleOSByGameConfig](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m.md) | Inicia ou reinicia o Game OS com base no conteúdo de um arquivo MicrosoftGame.config armazenado na memória como uma cadeia de caracteres. |
| [XtfStartTitleOSByVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m.md) | Inicia ou reinicia, a partir do cache no console, o Game OS que corresponde à [FourPartVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) especificada. |

## Funções de Pasta de Sobreposição

| Função de Pasta de Sobreposição | Descrição |
| - | - |
| [XtfClearAllOverlayFolders](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md) | Limpa os caminhos da Pasta de Sobreposição de todos os pacotes instalados/registrados no console. |
| [XtfGetOverlayFolder](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m.md) | Obtém o caminho da Pasta de Sobreposição de um pacote especificado. |
| [XtfSetOverlayFolder](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md) | Define o caminho da Pasta de Sobreposição de um pacote especificado. |

## Estruturas

| Estrutura | Descrição |
| - | - |
| [FourPartVersion](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) | O número de versão de quatro partes de um Game OS. |

## Enumerações

| Enumeração | Descrição |
| - | - |
| [Enumeração XtfConsoleCertType](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t.md) | Reservado para uso interno. |
| [Enumeração XtfConsoleFieldId](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) | Identifica o valor a ser retornado por [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md). |
| [Enumeração XtfConsoleFieldType](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t.md) | Identifica o tipo do valor retornado por XtfGetConsoleFieldValue. |


## Related topics

- [Membros do XtfRemoteRun (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfremoterun/xtfremoterun_members.md)
- [XtfInput (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfinput/xtfinput-xbox-microsoft-n.md)
- [XtfFileIO (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtffileio/xtffileio-xbox-microsoft-n.md)
- [XtfApplication (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapplication/xtfapplication-xbox-microsoft-n.md)
- [XtfUser (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md)
