Package.EffectiveExternalPath Property

Definition

Namespace:

Windows.ApplicationModel

Gets the location of the machine-wide or per-user external folder specified in the package manifest for the current package, depending on how the app is installed.

public:
 property Platform::String ^ EffectiveExternalPath { Platform::String ^ get(); };

winrt::hstring EffectiveExternalPath();

public string EffectiveExternalPath { get; }

var string = package.effectiveExternalPath;

Public ReadOnly Property EffectiveExternalPath As String

Property Value

String

Platform::String

winrt::hstring

The location of the machine-wide or per-user machine-wide external folder specified in the package manifest for the current package, depending on how the app is installed.

Windows requirements

Device family	Windows 10, version 2004 (introduced in 10.0.19041.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v10.0)

Remarks

The external folder is a disk location outside of the package where the package manifest can reference application content. This property returns either the machine-wide or per-user location of the external folder for the current package, depending on whether the app is provisioned for all users on the machine or on a per-user basis.

This property is intended to be used when you are granting package identity by packaging with external location. A package with external location contains only a package manifest (not an executable or other application content). The package manifest references application content in an external disk location outside of the package.

To set the external folder, use one of the following combinations of PackageManager methods and related options properties:

• AddPackageByUriAsync: Set the ExternalLocationUri property of the options parameter.
• RegisterPackageByUriAsync: Set the ExternalLocationUri property of the options parameter.
• StagePackageByUriAsync: Set the ExternalLocationUri property of the options parameter.

See also

• AddPackageByUriAsync(Uri, AddPackageOptions)
• RegisterPackageByUriAsync(Uri, RegisterPackageOptions)
• StagePackageByUriAsync(Uri, StagePackageOptions)