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

# XPackageGetInstallationProgress

> XPackageGetInstallationProgress

# XPackageGetInstallationProgress

返回安装的当前进度。

## 语法

```cpp theme={null}
void XPackageGetInstallationProgress(  
         XPackageInstallationMonitorHandle installationMonitor,  
         XPackageInstallationProgress* progress  
)  
```

### 参数

*installationMonitor*   \_In\_\
类型：XPackageInstallationMonitorHandle

安装监视器的句柄。

*progress*   \_Out\_\
类型：[XPackageInstallationProgress\*](/reference/system/xpackage/structs/xpackageinstallationprogress)

返回时，包含安装的当前进度。

### 返回值

类型：void

## 备注

若要获取安装的当前进度，请调用 [XPackageGetInstallationProgress](/reference/system/xpackage/functions/xpackagegetinstallationprogress)；若要在安装过程中获得变化通知，请注册回调。你可以为整个程序包或特定子集创建安装监视器。

在新内容首次安装过程中的某一时刻，运行时无法计算程序包的总大小，因为安装尚未完全开始。在这种情况下，运行时将返回 UINT64\_MAX 作为 totalBytes 的值，所有其他字段返回零或 false。

示例：

```cpp theme={null}
void CALLBACK ProgressChangedCallback(
    void* /* context*/,
    XPackageInstallationMonitorHandle monitor)
{
    XPackageInstallationProgress progress;
    XPackageGetInstallationProgress(monitor, &progress);

    if (progress.completed)
    {
        printf("Track ready\n");
        XPackageCloseInstallationMonitorHandle(monitor);
    }
}

HRESULT StartMonitoring(XTaskQueueHandle queue, char* trackName)
{
    char id[XPACKAGE_IDENTIFIER_MAX_LENGTH];

    HRESULT hr = XPackageGetCurrentProcessPackageIdentifier(_countof(id), id);
    if (FAILED(hr)) return hr;

    XPackageChunkSelector selector;
    selector.type = XPackageChunkSelectorType::Tag;
    selector.tag = trackName;

    XPackageInstallationMonitorHandle monitor;
    hr = XPackageCreateInstallationMonitor(
        id,         // Identity to be monitored
        1,          // Number of selectors
        &selector,  // Selectors
        1000,       // Resolution of the monitor, in milliseconds
        queue,      // Queue where updates are performed
        &monitor);
    if (FAILED(hr)) return hr;

    XTaskQueueRegistrationToken token;
    hr = XPackageRegisterInstallationProgressChanged(
        monitor,
        nullptr,
        ProgressChangedCallback,
        &token);

    if (FAILED(hr))
    {
        XPackageCloseInstallationMonitorHandle(monitor);
    }

    return hr;
}
```

下面逐一说明上面代码中的每个 API 调用：

```cpp theme={null}
XPackageGetCurrentProcessPackageIdentifier(_countof(id), id); 
```

所有已安装的内容都有唯一标识符。只要你知道任何程序包的标识符并可以访问该内容，就可以监视其安装。运行中的进程可以获取自己的程序包标识符。有关程序包标识符的详细信息，请参阅[管理和许可可下载内容 (DLC)](https://learn.microsoft.com/gaming/gdk/docs/store/commerce/fundamentals/xstore-manage-and-license-optional-packages)。

```cpp theme={null}
XPackageCreateInstallationMonitor( 
    id,         // Identity to be monitored 
    1,          // Number of selectors 
    &selector,  // Selectors 
    1000,       // Resolution of the monitor, in milliseconds 
    queue,      // Queue where updates are performed 
    &monitor); 
```

这将创建一个跟踪安装状态的监视器。此安装监视器按规律的节奏更新自身。若要获取安装的当前进度，请调用 [XPackageGetInstallationProgress](/reference/system/xpackage/functions/xpackagegetinstallationprogress)；若要在安装过程中获得变化通知，请注册回调。

你可以为整个程序包或特定子集创建安装监视器。在此，你已定义了一个“选择器”，用于表示你想了解某个赛道名称的安装进度。你可以指定频率（在此为 1000 ms），指示安装监视器更新其进度快照的频率上限。如果没有及时的进度发生，可能会更慢。

```cpp theme={null}
hr = XPackageRegisterInstallationProgressChanged(
    monitor,
    nullptr,
    ProgressChangedCallback,
    &token);
```

你想知道赛道何时加载完毕，因此在监视器上注册了一个进度变更事件。此回调将通过创建监视器时提供的任务队列调用，大致按照 [XPackageCreateInstallationMonitor](/reference/system/xpackage/functions/xpackagecreateinstallationmonitor) 中指定的节奏。在回调内部，你可以呈现游戏内进度或通知游戏赛道已准备就绪。

在此示例中，你关闭了安装监视器但没有取消注册通知。安装监视器通知的生存期与安装监视器绑定；因此，关闭该监视器会取消对其注册的所有通知。

## 要求

**头文件：** XPackage.h

**库：** xgameruntime.lib

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## 概念性文档

* [智能交付：语言说明符](/build/core-features/common/packaging/intelligentdelivery-language)

## 另请参阅

[XPackage](/reference/system/xpackage/xpackage_members)


## Related topics

- [XPackageInstallationProgressCallback](/zh-CN/reference/system/xpackage/functions/xpackageinstallationprogresscallback.md)
- [XPackageRegisterInstallationProgressChanged](/zh-CN/reference/system/xpackage/functions/xpackageregisterinstallationprogresschanged.md)
- [XPackageUpdateInstallationMonitor](/zh-CN/reference/system/xpackage/functions/xpackageupdateinstallationmonitor.md)
- [XPackage](/zh-CN/reference/system/xpackage/xpackage_members.md)
- [XPackageCreateInstallationMonitor](/zh-CN/reference/system/xpackage/functions/xpackagecreateinstallationmonitor.md)