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

# APIs adicionais do Xtf

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

<a id="ID4EM" />

## Funções de aplicativo

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

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

| Função de informações do console | Descrição |
| - | - |
| [XtfCloseConsoleInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m) | Libera os recursos associados a um objeto **XtfConsoleInfo** retornado por XtfGetConsoleInfoList. |
| [XtfGetAvailableSpaceForAppInstallation](/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m) | Obtém o número total de bytes disponíveis no dispositivo de armazenamento especificado de um console de desenvolvimento. |
| [XtfGetConsoleFieldValue](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) | 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](/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m) | Retorna um objeto `XtfConsoleInfo` que contém informações sobre um console. |
| [XtfGetSavedConsoleAddress](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m) | Obtém o endereço IP de ferramentas do console padrão para aplicativos do XBOX Tools Framework (XTF). |
| [XtfGetSystemUpTime](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m) | Obtém o tempo, em milissegundos, durante o qual o System OS e o Game OS estão em execução. |
| [XtfWaitForConsoleOSReady](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m) | Aguarda até que o sistema operacional do console esteja pronto para receber comandos antes de retornar. |
| [XtfWaitForConsoleState](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m) | Adiciona credenciais (nome de usuário e senha) ao console especificado para uso pela Implantação Executar a partir do PC. |
| [XtfCloseCredentialInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m) | Libera os recursos associados a um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfGetCredentialInfoCount](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m) | Obtém a contagem de credenciais armazenadas em um objeto `XtfNetworkCredentials` retornado por [XtfGetCredentialInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m). |
| [XtfGetCredentialInfoList](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m) | Retorna um objeto `XtfNetworkCredentials` que contém a lista de credenciais armazenadas atualmente no console. |
| [XtfGetCredentialServerName](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m) | Obtém a parte do nome do servidor das credenciais armazenadas em um índice de um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfGetCredentialUserName](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m) | Obtém a parte do nome de usuário das credenciais armazenadas em um índice de um objeto XtfNetworkCredentials retornado por XtfGetCredentialInfoList. |
| [XtfRemoveCredential](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m) | Remove credenciais do console especificado. Use XtfAddCredential para adicionar credenciais. |

## Funções de depuração

| Função de depuração | Descrição |
| - | - |
| [XtfCaptureOutputBegin](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m) | Inicia a captura da saída de depuração. |
| [XtfCaptureOutputEnd](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m) | Interrompe a captura da saída de depuração. |
| [XtfDebugStringCallback](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m) | Retorno de chamada invocado para cada cadeia de caracteres de saída de depuração capturada por [XtfCaptureOutputBegin](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m). |
| [XtfDebugStringErrorCallback](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m) | Retorno de chamada invocado para cada erro capturado por [XtfCaptureOutputBegin](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m). |
| [XtfGetErrorText](/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m) | Libera um objeto de informações do pacote. |
| [XtfGetAumid](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m) | Obtém a ID do modelo de usuário do aplicativo em um índice de um objeto de informações do pacote. |
| [XtfGetCountofAppUserModelIds](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m) | Obtém a contagem de IDs de modelo de usuário do aplicativo de um objeto de informações do pacote. |
| [XtfGetPackageFullName](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m) | Obtém o nome completo do pacote de um objeto de informações do pacote. |
| [XtfRegisterAllPackagesOnDrive](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m) | Registra todos os pacotes implantados na unidade especificada. |
| [XtfRegisterNetworkSharePackage](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m) | Registra um pacote para a Implantação Executar a partir do PC. |
| [XtfRegisterPackage](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m) | Registra um pacote implantado na unidade de rascunho do título. |
| [XtfRegisterPackageOnDrive](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m) | Registra um pacote implantado na unidade especificada. |
| [XtfUnregisterPackage](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m) | Adiciona um Game OS ao cache do sistema operacional. |
| [XtfGetCachedTitleOSVersions](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m) | Obtém as informações de versão de cada Game OS armazenado em cache no console. |
| [XtfGetCachedTitleOSVersionsCallback](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m) | Retorno de chamada invocado para cada Game OS encontrado por [XtfGetCachedTitleOSVersions](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m). |
| [XtfGetTitleOSFourPartVersion](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m) | Obtém informações de versão sobre o Game OS do título em execução no momento. |
| [XtfGetTitleOSState](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m) | Reservado para uso interno. |
| [XtfRemoveTitleOSFromCache](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m) | Remove um Game OS do cache no console. |
| [XtfRemoveTitleOSFromCacheByVersion](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m) | Remove do cache no console o Game OS que corresponde à [FourPartVersion](/pt-BR/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s) especificada. |
| [XtfShutdownTitleOS](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m) | Desliga o título ativo e o Game OS. |
| [XtfStartTitleOS](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m) | Inicia ou reinicia o Game OS especificado. |
| [XtfStartTitleOSByGameConfig](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m) | 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](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m) | Inicia ou reinicia, a partir do cache no console, o Game OS que corresponde à [FourPartVersion](/pt-BR/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s) especificada. |

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

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

## Estruturas

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

## Enumerações

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


## Related topics

- [XtfRegisterPackage](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md)
- [XtfAddCredential](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md)
- [XtfCacheTitleOS](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md)
- [XtfStartTitleOS](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md)
- [XtfShutdownTitleOS](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md)
