MSIX FindPackageFile*() API by DrusTheAxe · Pull Request #6200 · microsoft/WindowsAppSDK

DrusTheAxe · 2026-02-09T06:32:35Z

Implementation of MSIX FindPackageFile*() API Spec#5885

NOTE: SearchStatic/DynamicDependencies options are dropped from spec because Windows doesn't expose this information. Get[Current]PackageInfo*() accepts an input to optionally filter package graph entries but output doesn't indicate if a package was statically or dynamically added to the package graph.

…o fix compile error. Cleaned up (optimized) several test projects.

… test updates

…e it (Windows/GetCurrentPackageInfo doesn't return that distinction)

letao-msft · 2026-04-01T16:47:07Z

test/Package/data/UserExternal/appxmanifest.xml

+    <PublisherDisplayName>Microsoft Corporation</PublisherDisplayName>
+    <Logo>logo.png</Logo>
+    <uap15:DependencyTarget>true</uap15:DependencyTarget>
+    <uap10:AllowExternalContent>true</uap10:AllowExternalContent>


AllowExternalContent

What's the difference between the UserExternal package and the MachineExternal package?

letao-msft · 2026-04-01T17:09:35Z

dev/Package/package_runtime.cpp

+        else
+        {
+            return GetPackageFilePathOptions_SearchInstallPath |
+                   nonLocationOptions;


;

Should be |
(or delete the next line, since it's redundant with nonLocationOptions)

letao-msft · 2026-04-01T17:12:11Z

dev/Common/AppModel.Package.h

+    inline void initialize()
+    {
+        wil::unique_hmodule dll;
+        if (::ExportLoader::Load(L"api-ms-win-appmodel-runtime-l1-1-3.dll", wil::out_param(dll)))


Load

This function returns HRESULT but it's checked as if a bool

letao-msft · 2026-04-01T17:13:12Z

dev/Common/TerminalVelocityFeatures-PackageRuntime.h

+{
+
+__pragma(detect_mismatch("ODR_violation_WINDOWSAPPRUNTIME_MICROSOFT_WINDOWS_APPLICATIONMODEL_FEATURE_PACKAGERUNTIME_ENABLED_mismatch", "AlwaysEnabled"))
+struct Feature_PackageRuntime


Feature_PackageRuntime

The feature is defined but isn't used in code anywhere?

letao-msft · 2026-04-01T17:15:56Z

dev/Common/AppModel.Package.h

+    PCWSTR filename,
+    PackagePathType packageType)
+{
+    const auto path{ ::AppModel::Package::GetPath<std::wstring>(packageFullName, packageType) };


GetPath

This might return empty string - should that be handled as a special case?
std::filesystem::absolute("" / filename) might return a bogus result.

letao-msft · 2026-04-01T17:16:56Z

test/Package/API/PackageTests_Package_CPP.cpp

+namespace TD = ::Test::Diagnostics;
+namespace TB = ::Test::Bootstrap;
+namespace TP = ::Test::Packages;
+namespace TD = ::Test::Diagnostics;


This is already defined on line 10

letao-msft · 2026-04-01T17:17:12Z

test/Package/API/PackageTests_Package_WinRT.cpp

+namespace TD = ::Test::Diagnostics;
+namespace TB = ::Test::Bootstrap;
+namespace TP = ::Test::Packages;
+namespace TD = ::Test::Diagnostics;


This is already defined on line 8

letao-msft · 2026-04-01T18:35:08Z

build/NuSpecs/AppxManifest.xml

        <ActivatableClass ActivatableClassId="Microsoft.Windows.ApplicationModel.DynamicDependency.PackageDependencyRank" ThreadingModel="both" />

+        <!-- Package -->
+        <ActivatableClass ActivatableClassId="Microsoft.Windows.ApplicationModel.Package" ThreadingModel="both" />


Package

Should PackageGraph also be added here?

letao-msft · 2026-04-01T18:53:21Z

dev/Common/AppModel.Package.h

+            std::call_once(g_onceFlag, initialize);
+            RETURN_HR_IF_NULL(E_NOTIMPL, g_getPackagePathByFullName2);
+
+            RETURN_IF_FAILED(g_getPackagePathByFullName2(packageFullName, packagePathType, pathLength, path));


g_getPackagePathByFullName2

This returns win32 error (LONG), not HRESULT

letao-msft · 2026-04-01T18:53:46Z

dev/Common/AppModel.Package.h

+            // Only Install location is supported by the current system
+            // Effective is thus equivalent to Install
+            // Either way, rock it old school...
+            RETURN_IF_FAILED(::GetPackagePathByFullName(packageFullName, pathLength, path));


GetPackagePathByFullName

This returns win32 error (LONG), not HRESULT

letao-msft · 2026-04-01T19:02:32Z

dev/Package/package_runtime.cpp

+    {
+        return options | maskPackageTypes;
+    }
+    return options;


The IDL says

/// @note If SearchInstallPath, SearchMutablePath, SearchMachineExternalPath and SearchUserExternalPath /// are omitted then all locations are searched (i.e. specify all or none yields the same result).

But this path doesn't add all those options if none of them is specified (i.e. when only SearchPackages is specified, but none of SearchPath is specified).

letao-msft · 2026-04-01T19:05:48Z

dev/Package/package_runtime.cpp

+    PCWSTR packageFullName,
+    _In_ PCWSTR filename,
+    _In_ GetPackageFilePathOptions options,
+    _Outptr_result_maybenull_ PWSTR* packageFile) noexcept try


packageFile

For public APIs, validate if parameter is null before using (applies throughout).

letao-msft · 2026-04-01T19:15:42Z

dev/Package/Package.idl

+    [flags]
+    enum GetFilePathOptions
+    {
+        /// Default behavior


Describe what "default behavior" is (e.g. "Searches all paths and package types")

letao-msft · 2026-04-01T19:35:34Z

dev/Common/AppModel.Package.h

+
+    // It's bigger than a breadbox. Allocate memory
+    std::unique_ptr<WCHAR[]> pathBuffer{ std::make_unique<WCHAR[]>(pathLength) };
+    THROW_IF_WIN32_ERROR_MSG(details::GetPackagePathByFullName2IfSupported(packageFullName, packagePathType, &pathLength, pathBuffer.get()),


GetPackagePathByFullName2IfSupported

This function returns HRESULT but is checked for win32 error

letao-msft · 2026-04-01T20:04:36Z

dev/Package/package_runtime.cpp

+        const auto& packageInfo{ packageInfos[index] };
+
+        // Does the package's properties match our search criteria?
+        const auto packageInfoFlags{ appmodel::package_properties_to_options(packageInfo.flags) };


packageInfoFlags

After conversion in package_properties_to_options, this should be called packagePathOptions (of type GetPackageFilePathOptions). It is no longer packageInfoFlags (of type uint32_t).

letao-msft · 2026-04-01T20:06:42Z

dev/Package/package_runtime.cpp

+
+inline bool is_match_for_package_properties(
+    _In_ GetPackageFilePathOptions options,
+    std::uint32_t packageInfoFlags)


std::uint32_t packageInfoFlags

This parameter should be
GetPackageFilePathOptions packagePathOptions

"uint32_t packageInfoFlags" can easily be confused with PACKAGE_INFO.flags, which is the wrong type.

letao-msft · 2026-04-01T20:10:08Z

dev/Common/AppModel.Package.h

+        //   * PackagePathType_Install is available since Win8
+        //   * PackagePathType_Mutable is available since 19H1
+        //   * PackagePathType_Effective is available since 19H1
+        //   * PackagePathType_MachineExternalLocation is available since 20H1


PackagePathType_MachineExternalLocation

The value is called "PackagePathType_MachineExternal" (without "Location"). Similarly for PackagePathType_UserExternal and PackagePathType_EffectiveExternal below.

letao-msft · 2026-04-01T20:11:05Z

dev/Package/package_runtime.cpp

+    //   * PackagePathType_MachineExternalLocation is available since 20H1
+    //   * PackagePathType_UserExternalLocation is available since 20H1
+    //   * PackagePathType_EffectiveExternalLocation is available since 20H1
+    // GetPackagePathByFullName() is available since Win8


The value is called "PackagePathType_MachineExternal" (without "Location"). Similarly for PackagePathType_UserExternal and PackagePathType_EffectiveExternal below.

letao-msft · 2026-04-01T20:46:41Z

path = package.GetInstallPath()

This pseudocode doesn't match the implementation.
package_runtime.cpp line 205 checks if SearchInstallPath is in options before getting install path, but here it's unconditional.

Refers to: specs/package/Package.md:150 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T20:57:52Z

dev/Package/Package.idl

+        /// @note If a package has a UserExternal location then MachineExternal location is not checked (even if the package has one).
+        /// @see https://learn.microsoft.com/en-us/windows/win32/api/appmodel/nf-appmodel-getpackagepathbyfullname2
+        /// @see PackageGraph.GetFilePath
+        /// @see PackageGraph.GetFilePathOptions


GetFilePathOptions

Is this referring to GetFilePathWithOptions?
(Add the word "With")
PackageGraph.GetFilePathOptions doesn't exist.

letao-msft · 2026-04-01T20:58:41Z

dev/Package/Package.idl

+        /// @note If a package has a UserExternal location then MachineExternal location is not checked (even if the package has one).
+        /// @see https://learn.microsoft.com/en-us/windows/win32/api/appmodel/nf-appmodel-getpackagepathbyfullname2
+        /// @see Package.GetFilePath
+        /// @see GetPackageFilePathOptions


GetPackageFilePathOptions

Is this referring to Package.GetFilePathInPackageWithOptions?
Or enum GetFilePathOptions?

letao-msft · 2026-04-01T20:59:36Z

var options = GetPackageFilePathOptions.SearchInstallPath |

The IDL only defines GetFilePathOptions.
GetPackageFilePathOptions is an internal C++ impl type.

Same applies throughout.

Refers to: specs/package/Package.md:281 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:00:30Z

if (absoluteFilename == null)

The API returns empty string - does that really map to null in C#?
Consider using string.IsNullOrEmpty(absoluteFileName).

Refers to: specs/package/Package.md:285 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:02:03Z

specs/package/Package.md

@@ -377,9 +377,7 @@ string GetXamlWinMD()
                  GetPackageFilePathOptions.SearchUserExternalPath |
                  GetPackageFilePathOptions.SearchMainPackages |
                  GetPackageFilePathOptions.SearchFrameworkPath |


SearchFrameworkPath

SearchFrameworkPackages?
Similarly for SearchOptionalPackages.
Same applies throughout.

letao-msft · 2026-04-01T21:02:59Z

    wprintf(L"ERROR: Microsoft.UI.Xaml.winmd not found\n", hr);

There is no % specifier that matches this argument.

Refers to: specs/package/Package.md:356 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:03:38Z

    wprintf(L"ERROR: resources.pri not found for %ls\n", hr, packageFullName);

There is no % specifier that matches this argument

Refers to: specs/package/Package.md:262 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:04:19Z

    wprintf(L"ERROR: resources.pri not found for %ls\n", hr, packageFullName);

There is no % specifier that matches this argument

Refers to: specs/package/Package.md:312 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:04:36Z

    wprintf(L"ERROR: Microsoft.UI.Xaml.winmd not found\n", hr);

There is no % specifier that matches this argument

Refers to: specs/package/Package.md:412 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:05:23Z

std::wstring GetResourcesPri(PCWSTR packageFullName)

This parameter is never used

Refers to: specs/package/Package.md:205 in 50e998b. [](commit_id = 50e998b, deletion_comment = False)

letao-msft · 2026-04-01T21:06:39Z

specs/package/Package.md


 Locate `Microsoft.UI.Xaml.winmd` in the current process' package graph but ignore Mutable locations,
-Resource packages and HostRuntime dependencies.
+Resource and Resource packages and HostRuntime dependencies.


Resource and Resource

Typo?

DrusTheAxe added 22 commits June 23, 2025 12:17

GetPackageFile()

b57ac41

Merge branch 'main' into user/drustheaxe/FindPackageFile

5996e25

Fix bugs. Add start of tests

10643e9

Don't checkin *.bak

3e74652

Added Package activatable class to manifests

d41dd14

Partial implementation

9912d17

Merge branch 'main' into user/drustheaxe/FindPackageFile

99bc5dd

GetFilePath initial implementation

7f25624

Merge branch 'main' into user/drustheaxe/FindPackageFile

9fcfd8a

Improved tests. Added dllmain

115ef4e

Merge branch 'main' into user/drustheaxe/FindPackageFile

f93b30d

More tests. Added dev\common to various test projects' Include path t…

c70c361

…o fix compile error. Cleaned up (optimized) several test projects.

Test fixes

4ffc762

Fixed missing build dependencies

4416815

More tests. Checkpointing code in progress

67cf0f1

Added TAEF VERIFY_* support for std::filesystem::path. More fixes and…

2d14aff

… test updates

Expanded tests. Bug fixes

85716e8

Added missing test type

16b7acf

Checkpoint

e3004bb

Fixes

9db4965

Removed SearchStatic/DynamicDependencies options as we can't determin…

9f4fbc9

…e it (Windows/GetCurrentPackageInfo doesn't return that distinction)

Tweaks

7f6c9af

DrusTheAxe requested review from SaChinta-MSFT, cwruss, joshusto, letao-msft, rhuang-msft and wcheng-msft February 9, 2026 06:32

DrusTheAxe self-assigned this Feb 9, 2026

DrusTheAxe added the area-PackageManagement MSIX deployment technology (eg PackageDeploymentManager) label Feb 9, 2026

letao-msft reviewed Apr 1, 2026

View reviewed changes

Conversation

DrusTheAxe commented Feb 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

letao-msft Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

letao-msft commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

letao-msft Apr 1, 2026 •

edited

Loading