PackageVolume PackageVolume PackageVolume PackageVolume Class

Definition

Represents a package storage volume.

public : sealed class PackageVolume : IPackageVolume, IPackageVolume2public sealed class PackageVolume : IPackageVolume, IPackageVolume2Public NotInheritable Class PackageVolume Implements IPackageVolume, IPackageVolume2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

IsAppxInstallSupported IsAppxInstallSupported IsAppxInstallSupported IsAppxInstallSupported

Gets a boolean that indicates if APPX installing is supported.

public : PlatForm::Boolean IsAppxInstallSupported { get; }public bool IsAppxInstallSupported { get; }Public ReadOnly Property IsAppxInstallSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

The boolean that indicates that APPX installing is supported.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsFullTrustPackageSupported IsFullTrustPackageSupported IsFullTrustPackageSupported IsFullTrustPackageSupported

Gets a boolean that indicates if full-trust packages are supported.

public : PlatForm::Boolean IsFullTrustPackageSupported { get; }public bool IsFullTrustPackageSupported { get; }Public ReadOnly Property IsFullTrustPackageSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

A boolean that indicates if full-trust packages are supported.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

IsOffline IsOffline IsOffline IsOffline

Describes whether a volume is in an offline state.

public : PlatForm::Boolean IsOffline { get; }public bool IsOffline { get; }Public ReadOnly Property IsOffline As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if the volume is in an offline state; otherwise, false.

IsSystemVolume IsSystemVolume IsSystemVolume IsSystemVolume

Describes whether a volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable.

public : PlatForm::Boolean IsSystemVolume { get; }public bool IsSystemVolume { get; }Public ReadOnly Property IsSystemVolume As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if the volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable; otherwise, false.

MountPoint MountPoint MountPoint MountPoint

Gets the path of the last known volume mount point.

public : PlatForm::String MountPoint { get; }public string MountPoint { get; }Public ReadOnly Property MountPoint As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The path of the last known volume mount point.

Remarks

This is a cached value. It may not represent the current state of the device or the volume.

Name Name Name Name

Gets the media ID of the volume.

public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The media ID of the volume.

PackageStorePath PackageStorePath PackageStorePath PackageStorePath

Gets the absolute path for the package store on the volume.

public : PlatForm::String PackageStorePath { get; }public string PackageStorePath { get; }Public ReadOnly Property PackageStorePath As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The absolute path for the package store on the volume.

SupportsHardLinks SupportsHardLinks SupportsHardLinks SupportsHardLinks

Gets a value that specifies whether the volume supports the creation of hard links in its file system.

public : PlatForm::Boolean SupportsHardLinks { get; }public bool SupportsHardLinks { get; }Public ReadOnly Property SupportsHardLinks As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if the volume supports the creation of hard links in its file system; otherwise, false.

Methods

FindPackage(String) FindPackage(String) FindPackage(String) FindPackage(String)

Gets a collection of info about all installed instances of the specified package for all registered users.

public : IVector<Package> FindPackage(PlatForm::String packageFullName)public IList<Package> FindPackage(String packageFullName)Public Function FindPackage(packageFullName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageFullName
PlatForm::String String String String

The full name of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about all installed instances of the specified package for all registered users.

FindPackageForUser(String, String) FindPackageForUser(String, String) FindPackageForUser(String, String) FindPackageForUser(String, String)

Gets a collection of info about the installed instances of the specified package for the specified user or users.

public : IVector<Package> FindPackageForUser(PlatForm::String userSecurityId, PlatForm::String packageFullName)public IList<Package> FindPackageForUser(String userSecurityId, String packageFullName)Public Function FindPackageForUser(userSecurityId As String, packageFullName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageFullName
PlatForm::String String String String

The full name of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about all installed instances of the specified package for the specified user or users.

FindPackages() FindPackages() FindPackages() FindPackages()

Gets a collection of info about all installed instances of all packages for all registered users.

public : IVector<Package> FindPackages()public IList<Package> FindPackages()Public Function FindPackages() As IList( Of Package )// You can use this method in JavaScript.
Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackages(String) FindPackages(String) FindPackages(String) FindPackages(String)

Gets a collection of info about all installed instances of the specified package for all registered users.

public : IVector<Package> FindPackages(PlatForm::String packageFamilyName)public IList<Package> FindPackages(String packageFamilyName)Public Function FindPackages(packageFamilyName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageFamilyName
PlatForm::String String String String

The package family name of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackages(String, String) FindPackages(String, String) FindPackages(String, String) FindPackages(String, String)

Gets a collection of info about all installed instances of the specified package from the specified publisher for all registered users.

public : IVector<Package> FindPackages(PlatForm::String packageName, PlatForm::String packagePublisher)public IList<Package> FindPackages(String packageName, String packagePublisher)Public Function FindPackages(packageName As String, packagePublisher As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageName
PlatForm::String String String String

The full name of the package.

packagePublisher
PlatForm::String String String String

The publisher of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUser(String) FindPackagesForUser(String) FindPackagesForUser(String) FindPackagesForUser(String)

Gets a collection of info about all installed instances of all packages for the specified user or users.

public : IVector<Package> FindPackagesForUser(PlatForm::String userSecurityId)public IList<Package> FindPackagesForUser(String userSecurityId)Public Function FindPackagesForUser(userSecurityId As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUser(String, String) FindPackagesForUser(String, String) FindPackagesForUser(String, String) FindPackagesForUser(String, String)

Gets a collection of info about all installed instances of the specified package for the specified user or users.

public : IVector<Package> FindPackagesForUser(PlatForm::String userSecurityId, PlatForm::String packageFamilyName)public IList<Package> FindPackagesForUser(String userSecurityId, String packageFamilyName)Public Function FindPackagesForUser(userSecurityId As String, packageFamilyName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageFamilyName
PlatForm::String String String String

The package family name.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUser(String, String, String) FindPackagesForUser(String, String, String) FindPackagesForUser(String, String, String) FindPackagesForUser(String, String, String)

Gets a collection of info about all installed instances of the specified package from the specified publisher for the specified user or users.

public : IVector<Package> FindPackagesForUser(PlatForm::String userSecurityId, PlatForm::String packageName, PlatForm::String packagePublisher)public IList<Package> FindPackagesForUser(String userSecurityId, String packageName, String packagePublisher)Public Function FindPackagesForUser(userSecurityId As String, packageName As String, packagePublisher As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageName
PlatForm::String String String String

The full name of the package.

packagePublisher
PlatForm::String String String String

The publisher of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUserWithPackageTypes(String, PackageTypes) FindPackagesForUserWithPackageTypes(String, PackageTypes) FindPackagesForUserWithPackageTypes(String, PackageTypes) FindPackagesForUserWithPackageTypes(String, PackageTypes)

Gets a collection of info about all installed instances of all packages for the specified user or users and with the specified package types.

public : IVector<Package> FindPackagesForUserWithPackageTypes(PlatForm::String userSecurityId, PackageTypes packageTypes)public IList<Package> FindPackagesForUserWithPackageTypes(String userSecurityId, PackageTypes packageTypes)Public Function FindPackagesForUserWithPackageTypes(userSecurityId As String, packageTypes As PackageTypes) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUserWithPackageTypes(String, PackageTypes, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String)

Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types.

public : IVector<Package> FindPackagesForUserWithPackageTypes(PlatForm::String userSecurityId, PackageTypes packageTypes, PlatForm::String packageFamilyName)public IList<Package> FindPackagesForUserWithPackageTypes(String userSecurityId, PackageTypes packageTypes, String packageFamilyName)Public Function FindPackagesForUserWithPackageTypes(userSecurityId As String, packageTypes As PackageTypes, packageFamilyName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

packageFamilyName
PlatForm::String String String String

The package family name.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String) FindPackagesForUserWithPackageTypes(String, PackageTypes, String, String)

Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types.

public : IVector<Package> FindPackagesForUserWithPackageTypes(PlatForm::String userSecurityId, PackageTypes packageTypes, PlatForm::String packageName, PlatForm::String packagePublisher)public IList<Package> FindPackagesForUserWithPackageTypes(String userSecurityId, PackageTypes packageTypes, String packageName, String packagePublisher)Public Function FindPackagesForUserWithPackageTypes(userSecurityId As String, packageTypes As PackageTypes, packageName As String, packagePublisher As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
userSecurityId
PlatForm::String String String String

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges.

packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

packageName
PlatForm::String String String String

The full name of the package.

packagePublisher
PlatForm::String String String String

The publisher of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesWithPackageTypes(PackageTypes) FindPackagesWithPackageTypes(PackageTypes) FindPackagesWithPackageTypes(PackageTypes) FindPackagesWithPackageTypes(PackageTypes)

Gets a collection of info about all installed instances of all packages with the specified package types for all registered users.

public : IVector<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes)public IList<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes)Public Function FindPackagesWithPackageTypes(packageTypes As PackageTypes) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesWithPackageTypes(PackageTypes, String) FindPackagesWithPackageTypes(PackageTypes, String) FindPackagesWithPackageTypes(PackageTypes, String) FindPackagesWithPackageTypes(PackageTypes, String)

Gets a collection of info about all installed instances of the specified package with the specified package types for all registered users.

public : IVector<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes, PlatForm::String packageFamilyName)public IList<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes, String packageFamilyName)Public Function FindPackagesWithPackageTypes(packageTypes As PackageTypes, packageFamilyName As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

packageFamilyName
PlatForm::String String String String

The package family name.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

FindPackagesWithPackageTypes(PackageTypes, String, String) FindPackagesWithPackageTypes(PackageTypes, String, String) FindPackagesWithPackageTypes(PackageTypes, String, String) FindPackagesWithPackageTypes(PackageTypes, String, String)

Gets a collection of info about all installed instances of the specified package from the specified publisher with the specified package types for all registered users.

public : IVector<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes, PlatForm::String packageName, PlatForm::String packagePublisher)public IList<Package> FindPackagesWithPackageTypes(PackageTypes packageTypes, String packageName, String packagePublisher)Public Function FindPackagesWithPackageTypes(packageTypes As PackageTypes, packageName As String, packagePublisher As String) As IList( Of Package )// You can use this method in JavaScript.
Parameters
packageTypes
PackageTypes PackageTypes PackageTypes PackageTypes

A bitwise combination of the enumeration values that specifies the types of packages to return.

packageName
PlatForm::String String String String

The full name of the package.

packagePublisher
PlatForm::String String String String

The publisher of the package.

Returns
IVector<Package> IList<Package> IList<Package> IList<Package>

A collection of info about the specified packages.

See Also

GetAvailableSpaceAsync() GetAvailableSpaceAsync() GetAvailableSpaceAsync() GetAvailableSpaceAsync()

Gets the available space.

public : IAsyncOperation<ulong> GetAvailableSpaceAsync()public IAsyncOperation<ulong> GetAvailableSpaceAsync()Public Function GetAvailableSpaceAsync() As IAsyncOperation( Of ulong )// You can use this method in JavaScript.
Returns

Returns an asynchronous operation that will complete with the available space.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)