Skip to main content

XPackageGetInstallationProgress

Retourne la progression actuelle de l’installation.

Syntaxe

Paramètres

installationMonitor   _In_
Type : XPackageInstallationMonitorHandle
Handle du moniteur d’installation. progress   _Out_
Type : XPackageInstallationProgress*
Au retour, contient la progression actuelle de l’installation.

Valeur de retour

Type : void

Remarques

Pour obtenir la progression actuelle d’une installation, appelez XPackageGetInstallationProgress; pour être averti d’un changement pendant une installation, inscrivez un rappel. Vous pouvez créer le moniteur d’installation pour l’ensemble du package ou pour un sous-ensemble particulier. Pendant un moment lors d’une nouvelle installation de nouveau contenu, le runtime ne peut pas calculer la taille totale du package, car l’installation n’a pas encore complètement commencé. Dans ce cas, le runtime retournera UINT64_MAX comme valeur pour totalBytes, et zéro ou false pour tous les autres champs. Exemple :
Examinons chaque appel d’API dans le code présenté ci-dessus :
Tout le contenu installé aura un identificateur unique. Vous pouvez surveiller l’installation de n’importe quel package si vous connaissez l’identificateur du package et avez accès à ce contenu. Un processus en cours d’exécution peut obtenir son propre identificateur de package. Pour plus d’informations sur les identificateurs de package, consultez Gérer le contenu téléchargeable (DLC) et ses licences.
Ce code crée un moniteur qui suit l’état de l’installation. Ce moniteur d’installation se met à jour à intervalles réguliers. Pour obtenir la progression actuelle d’une installation, appelez XPackageGetInstallationProgress; pour être averti d’un changement pendant une installation, inscrivez un rappel. Vous pouvez créer le moniteur d’installation pour l’ensemble du package ou pour un sous-ensemble particulier. Ici, vous avez défini un « sélecteur » qui indique que vous souhaitez connaître la progression de l’installation pour un nom de piste. Vous pouvez spécifier une fréquence (dans ce cas, 1 000 ms) qui indique à quelle fréquence le moniteur d’installation mettra à jour son instantané de la progression, jusqu’à cette vitesse. Si aucune progression n’a été réalisée dans ce délai, la mise à jour pourrait être plus lente.
Vous voulez savoir quand le chargement de la piste est terminé, alors vous inscrivez un événement de changement de progression sur le moniteur. Ce rappel sera appelé par l’intermédiaire de la file d’attente de tâches fournie lors de la création du moniteur, à peu près à la fréquence spécifiée dans XPackageCreateInstallationMonitor. Dans le rappel, vous pouvez afficher la progression dans le jeu ou avertir le jeu qu’une piste est prête. Dans cet exemple, vous fermez le moniteur d’installation sans désinscrire la notification. La durée de vie d’une notification de moniteur d’installation est liée au moniteur d’installation; par conséquent, la fermeture du moniteur désinscrit toutes les notifications qui lui sont associées.

Configuration requise

En-tête : XPackage.h Bibliothèque : xgameruntime.lib Plateformes prises en charge : Windows, consoles de la famille XBOX One et consoles XBOX Series

Documentation conceptuelle

Voir aussi

XPackage
Last modified on October 6, 2026