Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Indicates the type of folder path to retrieve in a query for the path or other info about a package.
Syntax
typedef enum PackagePathType {
PackagePathType_Install,
PackagePathType_Mutable,
PackagePathType_Effective,
PackagePathType_MachineExternal,
PackagePathType_UserExternal,
PackagePathType_EffectiveExternal
} ;
Constants
PackagePathType_InstallRetrieve the package path in the original install folder for the application. |
PackagePathType_MutableRetrieve the package path in the mutable install folder for the application, if the application is declared as mutable in the package manifest. |
PackagePathType_EffectiveSpecifies that the package path should be retrieved according to the following logic: * If the package has a User-External location, then return that path. * Otherwise, if the package has a Machine-External location, then return that path. * Otherwise, if the package has a Mutable location, then return the Mutable path. Also see Create a directory in any location based on packaged app directory. * Otherwise, return an error. |
PackagePathType_MachineExternalSpecifies that the package path should be retrieved according to the following logic: * If the package has a Machine-External location, then return that path. * Otherwise, return an error. |
PackagePathType_UserExternalSpecifies that the package path should be retrieved according to the following logic: * If the package has a User-External location, then return that path. * Otherwise, return an error. |
PackagePathType_EffectiveExternalSpecifies that the package path should be retrieved according to the following logic: * If the package has a User-External location, then return that path. * Otherwise, if the package has a Machine-External location, then return that path. * Otherwise, return an error. |
Remarks
An application has a mutable install folder if it uses the windows.mutablePackageDirectories extension in its package manifest. This extension specifies a folder under the %ProgramFiles%\ModifiableWindowsApps path where the contents of the application's install folder are projected so that users can modify the installation files. This feature is currently available only for certain types of desktop PC games that are published by Microsoft and our partners, and it enables these types of games to support mods.
A package always has an Install location, and it can also have a Mutable or an External location, or even both. The concept of "effective" is the location that has the highest precedence for the package/user.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 10 [desktop apps only] |
| Minimum supported server | Windows Server 2016 [desktop apps only] |
| Header | appmodel.h |