Skip to main content

XPackageGetInstallationProgress

Retorna o progresso atual da instalação.

Sintaxe

Parâmetros

installationMonitor   _In_
Tipo: XPackageInstallationMonitorHandle
Um identificador para o monitor de instalação. progress   _Out_
Tipo: XPackageInstallationProgress*
No retorno, contém o progresso atual da instalação.

Valor retornado

Tipo: void

Comentários

Para obter o progresso atual de uma instalação, chame XPackageGetInstallationProgress; para ser notificado sobre uma alteração durante uma instalação, registre um retorno de chamada. Você pode criar o monitor de instalação para o pacote inteiro ou para um subconjunto específico. Por um momento, durante uma nova instalação de novo conteúdo, o runtime não consegue calcular o tamanho total do pacote, porque a instalação ainda não foi totalmente iniciada. Nesse caso, o runtime retornará UINT64_MAX como o valor de totalBytes e zero ou false para todos os outros campos. Exemplo:
Vamos analisar cada chamada de API no código mostrado acima:
Todo conteúdo instalado terá um identificador exclusivo. Você pode monitorar a instalação de qualquer pacote se souber o identificador do pacote e tiver acesso a esse conteúdo. Um processo em execução pode obter seu próprio identificador de pacote. Para obter mais informações sobre identificadores de pacote, consulte Gerenciar e licenciar conteúdo para download (DLC).
Isso cria um monitor que acompanha o estado da instalação. Esse monitor de instalação se atualiza em uma cadência regular. Para obter o progresso atual de uma instalação, chame XPackageGetInstallationProgress; para ser notificado sobre uma alteração durante uma instalação, registre um retorno de chamada. Você pode criar o monitor de instalação para o pacote inteiro ou para um subconjunto específico. Aqui, você definiu um “seletor” que indica que você deseja saber sobre o progresso da instalação de um nome de pista. Você pode especificar uma frequência (neste caso, 1000 ms) que indica com que frequência o monitor de instalação atualizará seu instantâneo do progresso, até essa velocidade. Se nenhum progresso tiver sido feito no tempo, ela poderá ser mais lenta.
Você deseja saber quando a pista terminou de carregar, portanto, registra um evento de alteração de progresso no monitor. Esse retorno de chamada será invocado por meio da fila de tarefas fornecida quando o monitor foi criado, aproximadamente na cadência especificada em XPackageCreateInstallationMonitor. Dentro do retorno de chamada, você pode renderizar o progresso no jogo ou notificar o jogo de que uma pista está pronta. Neste exemplo, você fecha o monitor de instalação, mas não cancela o registro da notificação. O tempo de vida de uma notificação do monitor de instalação está vinculado ao monitor de instalação; portanto, fechar o monitor cancela o registro de todas as notificações para ele.

Requisitos

Cabeçalho: XPackage.h Biblioteca: xgameruntime.lib Plataformas compatíveis: Windows, consoles da família XBOX One e consoles XBOX Series

Documentação conceitual

Confira também

XPackage
Last modified on October 6, 2026