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	Reservado para uso interno.
XtfPullRegisterApp	Reservado para uso interno.
XtfPullSupplyMock	Reservado para uso interno.
XtfPullUnregisterApp	Reservado para uso interno.

Funções de informações do console

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

Funções de depuração

Função de depuração	Descrição
XtfCaptureOutputBegin	Inicia a captura da saída de depuração.
XtfCaptureOutputEnd	Interrompe a captura da saída de depuração.
XtfDebugStringCallback	Retorno de chamada invocado para cada cadeia de caracteres de saída de depuração capturada por XtfCaptureOutputBegin.
XtfDebugStringErrorCallback	Retorno de chamada invocado para cada erro capturado por XtfCaptureOutputBegin.
XtfGetErrorText	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	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	Libera um objeto de informações do pacote.
XtfGetAumid	Obtém a ID do modelo de usuário do aplicativo em um índice de um objeto de informações do pacote.
XtfGetCountofAppUserModelIds	Obtém a contagem de IDs de modelo de usuário do aplicativo de um objeto de informações do pacote.
XtfGetPackageFullName	Obtém o nome completo do pacote de um objeto de informações do pacote.
XtfRegisterAllPackagesOnDrive	Registra todos os pacotes implantados na unidade especificada.
XtfRegisterNetworkSharePackage	Registra um pacote para a Implantação Executar a partir do PC.
XtfRegisterPackage	Registra um pacote implantado na unidade de rascunho do título.
XtfRegisterPackageOnDrive	Registra um pacote implantado na unidade especificada.
XtfUnregisterPackage	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	Adiciona um Game OS ao cache do sistema operacional.
XtfGetCachedTitleOSVersions	Obtém as informações de versão de cada Game OS armazenado em cache no console.
XtfGetCachedTitleOSVersionsCallback	Retorno de chamada invocado para cada Game OS encontrado por XtfGetCachedTitleOSVersions.
XtfGetTitleOSFourPartVersion	Obtém informações de versão sobre o Game OS do título em execução no momento.
XtfGetTitleOSState	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	Reservado para uso interno.
XtfRemoveTitleOSFromCache	Remove um Game OS do cache no console.
XtfRemoveTitleOSFromCacheByVersion	Remove do cache no console o Game OS que corresponde à FourPartVersion especificada.
XtfShutdownTitleOS	Desliga o título ativo e o Game OS.
XtfStartTitleOS	Inicia ou reinicia o Game OS especificado.
XtfStartTitleOSByGameConfig	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	Inicia ou reinicia, a partir do cache no console, o Game OS que corresponde à FourPartVersion especificada.

Funções de Pasta de Sobreposição

Função de Pasta de Sobreposição	Descrição
XtfClearAllOverlayFolders	Limpa os caminhos da Pasta de Sobreposição de todos os pacotes instalados/registrados no console.
XtfGetOverlayFolder	Obtém o caminho da Pasta de Sobreposição de um pacote especificado.
XtfSetOverlayFolder	Define o caminho da Pasta de Sobreposição de um pacote especificado.

Estruturas

Estrutura	Descrição
FourPartVersion	O número de versão de quatro partes de um Game OS.

Enumerações

Enumeração	Descrição
Enumeração XtfConsoleCertType	Reservado para uso interno.
Enumeração XtfConsoleFieldId	Identifica o valor a ser retornado por XtfGetConsoleFieldValue.
Enumeração XtfConsoleFieldType	Identifica o tipo do valor retornado por XtfGetConsoleFieldValue.

Last modified on October 6, 2026

⌘I