XPackageInstalledCallback

Article
06/22/2023

A user-defined callback used by the XPackageRegisterPackageInstalled function.

Syntax

void XPackageInstalledCallback(  
         void* context,  
         const XPackageDetails* details  
)

Parameters

context _In_
Type: void*

The context passed to the XPackageRegisterPackageInstalled function.

details _In_
Type: XPackageDetails*

Contains details about the package installation.

Return value

Type: void

Returns a pointer to the package installation details.

Remarks

The XPackageInstalledCallback function is used to determine when a new package is completely installed. The following code example prints a message when a new downloadable content (DLC) package is installed.

void CALLBACK NewPackageAdded(void* /* context */, const XPackageDetails* details)
{
    if (details->kind == XPackageKind::Content)
    {
        printf("Package added: %s\n", details->displayName);
    }
}

HRESULT ListenForNewDlc(XTaskQueueHandle queue, XTaskQueueRegistrationToken* token)
{
    HRESULT hr = XPackageRegisterPackageInstalled(queue, nullptr, NewPackageAdded, token);
    return hr;
}

void StopListeningForDlc(XTaskQueueRegistrationToken token)
{
    XPackageUnregisterPackageInstalled(token, false);
}

For information about the packaging technology used with Xbox One titles, see Overview of Packaging. For information about the steps to create an XVC package, see Getting started packaging titles for Xbox consoles.

Requirements

Header: XPackage.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via