XtfGetPackageFullName

Article
06/22/2023

Gets the full package name from a package information object.

Syntax

HRESULT XtfGetPackageFullName(
         XtfPackageInfo packageInfo,
         PWSTR packageFullName,
         UINT32 *packageFullNameBufferLength
)

Parameters

packageInfo
Type: XtfPackageInfo

[in] A pointer to the information object for a package.

packageFullName
Type: PWSTR

[out, optional] The full name of the package.

packageFullNameBufferLength
Type: UINT32 *

[in, out] The length, in WCHAR, allocated for packageFullName.

Return value

Type: HRESULT

Returns S_OK if successful. If packageFullName is not large enough, this function returns HRESULT_FROM_WIN32(ERROR_MORE_DATA) and the required buffer length is returned in packageFullNameBufferLength.

Remarks

Use this function to get the full package name from the information object for a registered package. A pointer to a package information object is returned by calling either the XtfRegisterPackage or XtfRegisterNetworkSharePackage function to register a package.

You can also use the XtfGetCountofAppUserModelIds and XtfGetAumid functions to retrieve Application User Model IDs (AUMIDs) for a registered package. For more information about packages, see Packaging.

The full package name is used in the platform lifetime management operations found in the IXtfApplicationClient interface.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via