XtfRegisterPackageOnDrive

Article
06/22/2023

Registers a package deployed on the specified drive.

Syntax

HRESULT XtfRegisterPackageOnDrive(
         LPCWSTR address,
         PCWSTR packageFullName,
         DWORD drive,
         XtfPackageInfo* packageInfo
)

Parameters

address
Type: LPCWSTR

[in] The address of the console.

packageFullName
Type: PCWSTR

[in] The package full name of the package to register.

drive
Type: DWORD

[in] The drive to register the package on. This parameter accepts the following values:

Value	Description
0	Retail drive
1	Development drive
2 - 8	External drive 1 through external drive 7

packageInfo
Type: XtfPackageInfo*

[out] Package information object about the package that was registered.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an HRESULT error code.

Remarks

This function registers a package deployed to a specified drive, such as an external drive, and provides package information as an XtfPackageInfo object reference. Use the XtfGetPackageFullName, XtfGetCountofAppUserModelIds, and XtfGetAumid functions to get the package full name and Application User Model IDs (AUMIDs) for the registered package from the XtfPackageInfo object. Use XtfClosePackageInfo to free the XtfPackageInfo object when you are done with it.

For more information about managing applications, see Application Management (xbapp.exe) (NDA topic)Authorization required.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via