MSFT_Partition, ROOT\Microsoft\Windows\Storage\MS_409

Class | Methods (9) | Properties (15) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Represents a partition on a disk.

MSFT_Partition methods

MSFT_Partition has 9 methods (9 Local)

NameOriginReturn
AddAccessPathMSFT_Partitionuint32 {'out':True}
DeleteObjectMSFT_Partitionuint32 {'out':True}
GetAccessPathsMSFT_Partitionuint32 {'out':True}
GetSupportedSizeMSFT_Partitionuint32 {'out':True}
OfflineMSFT_Partitionuint32 {'out':True}
OnlineMSFT_Partitionuint32 {'out':True}
RemoveAccessPathMSFT_Partitionuint32 {'out':True}
ResizeMSFT_Partitionuint32 {'out':True}
SetAttributesMSFT_Partitionuint32 {'out':True}

MSFT_Partition properties

MSFT_Partition has 15 properties (15 Local)

NameOriginCIMType
AccessPathsMSFT_Partition8 [string]
key
DiskId
MSFT_Partition8 [string]
DiskNumberMSFT_Partition19 [uint32]
DriveLetterMSFT_Partition103 [char16]
GptTypeMSFT_Partition8 [string]
GuidMSFT_Partition8 [string]
IsActiveMSFT_Partition11 [boolean]
IsHiddenMSFT_Partition11 [boolean]
IsShadowCopyMSFT_Partition11 [boolean]
MbrTypeMSFT_Partition18 [uint16]
NoDefaultDriveLetterMSFT_Partition11 [boolean]
key
Offset
MSFT_Partition21 [uint64]
OperationalStatusMSFT_Partition18 [uint16]
PartitionNumberMSFT_Partition19 [uint32]
SizeMSFT_Partition21 [uint64]

Detailed description of MSFT_Partition methods

Local methods (9) of MSFT_Partition class

AddAccessPath method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AccessPathstring0-{'Description':'This parameter is a string indicating the access path, which is a user-mode path that can be used to open the partition. An access path can be a drive letter (in the form C: or C:\) or a path to an empty directory on an NTFS volume. The access path string does not require a trailing backslash.','In':True}
AssignDriveLetterboolean1-{'Description':'If this parameter is specified as TRUE, the next available drive letter will be assigned to the partition.','In':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus2-{'Out':True}
Description'This method adds a mount path or drive letter assignment to the partition. The AccessPath and AssignDriveLetter parameters are mutually exclusive, and will result in an invalid parameters error if both are specified at once. This method adds the access path by creating a mounted folder (also called a volume mount point). Note that mounted folders are supported only on NTFS formatted partitions. This method returns an error if the path specified in AccessPath is a folder that is already in use (even if the directory is empty) or if it contains a path to a non-empty directory.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'The requested access path is already in use.', 'Cannot assign access paths to hidden partitions.', 'The access path is not valid.', 'Cannot assign multiple drive letters to a partition.', 'Cannot assign drive letter to this type of partition.']
AddAccessPath method is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
DeleteObject method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ExtendedStatusobject:MSFT_StorageExtendedStatus0-{'Out':True}
Description'Deletes the partition and corresponding volume.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In use', 'Access denied', 'There are not enough resources to complete the operation.', 'The specified object is managed by the Microsoft Failover Clustering component. The disk must be in cluster maintenance mode and the cluster resource status must be online to perform this operation.', 'The partition was deleted, although its access paths were not.', 'The extended partition still contains other partitions.', 'The operation is not allowed on a system or critical partition.']
DeleteObject method is in 6 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 4 namespaces
GetAccessPaths method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AccessPathsstring0-{'Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Out':True}
Description'This method returns all mount points and drive letters that can be used to access the partition.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter']
GetAccessPaths method is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
GetSupportedSize method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SizeMinuint640-{'Description':'This output parameter contains the minimum size that this partition can become. Note that if this method is run multiple times, this value can change slightly depending on the placement of various temporary files.','Out':True}
SizeMaxuint641-{'Description':'This output parameter contains the maximum size that this partition can become.','Out':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus2-{'Out':True}
Description'This method returns the minimum and maximum sizes that the partition can be resized to using the Resize method. The minimum size is determined by the disk defragmenter and takes into account the location of immovable files. The maximum size is determined by adding the size of any free extents immediately after the current partition.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot shrink a partition containing a volume with errors.', 'Cannot resize a partition containing an unknown file system.']
GetSupportedSize method is in 3 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 3 namespaces
Offline method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ExtendedStatusobject:MSFT_StorageExtendedStatus0-{'Out':True}
Description'Takes the partition offline by dismounting the associated volume (if one exists). The partition remains offline until explicitly brought online or an access path is added to the partition.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'Access denied', 'There are not enough resources to complete the operation.', 'The specified object is managed by the Microsoft Failover Clustering component. The disk must be in cluster maintenance mode and the cluster resource status must be online to perform this operation.', 'This operation is only supported on data partitions.', 'The volume still has access path to it.']
Offline method is in 2 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 6 namespaces
Online method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ExtendedStatusobject:MSFT_StorageExtendedStatus0-{'Out':True}
Description'Onlines the partition by mounting the associated volume (if one exists).'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'Access denied', 'There are not enough resources to complete the operation.', 'This operation is only supported on data partitions.']
Online method is in 2 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 6 namespaces
RemoveAccessPath method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AccessPathstring0-{'In':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Out':True}
Description'This method removes the access path from the partition regardless of whether or not it is in use.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot remove a volume GUID path.', 'Cannot remove the drive letter of a boot or paging file partition.', 'The access path is not valid.']
RemoveAccessPath method is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
Resize method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Sizeuint640-{'In':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus1-{'Out':True}
Description'This method resizes the partition and any associated filesystem to the size specified by the Size parameter. If the size is outside of the bounds returned by the GetSupportedSize method, then this method will fail with a well defined error code. The resize operation is only supported on NTFS formatted partitions and RAW partitions.
If the specified size is smaller than the original size, this method will move files so that they are as close as possible to the beginning of the partition, in order to consolidate free space at the end of the partition. It then truncates the file system volume, reducing its size, and then truncates the partition.
In almost all cases, there will be some files that are immovable. For example, file system and storage driver metadata files are likely to be immovable. For this reason, the amount by which a partition can be shrunk is usually less than the total amount of free space on the partition.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'Size Not Supported', 'Access denied', 'There are not enough resources to complete the operation.', 'Cannot shrink a partition containing a volume with errors.', 'Cannot resize a partition containing an unknown file system.', 'This operation is only supported on data partitions.']
Resize method is in 3 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 4 namespaces
SetAttributes method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
IsReadOnlyboolean0-{'In':True}
NoDefaultDriveLetterboolean1-{'In':True}
IsActiveboolean2-{'In':True}
IsHiddenboolean3-{'In':True}
ExtendedStatusobject:MSFT_StorageExtendedStatus4-{'Out':True}
Description'Sets various attributes and properties of the partition.'
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'In Use', 'Access denied', 'There are not enough resources to complete the operation.', 'Cache out of date', 'The disk has not been initialized.', 'The disk is offline.', 'A parameter is not valid for this type of partition.', 'The specified object is managed by the Microsoft Failover Clustering component. The disk must be in cluster maintenance mode and the cluster resource status must be online to perform this operation.', 'The operation is not allowed on a system or critical partition.', 'This operation is only supported on data partitions.']
SetAttributes method is in 9 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 3 namespaces

Detailed description of MSFT_Partition properties

Local properties (15) of MSFT_Partition class

AccessPaths property
CIMTYPE'string'
Description'This property is an array of all the various mount points for the partition. This list includes drive letters, as well as mounted folders.'
AccessPaths property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
DiskId property
CIMTYPE'string'
Description'This is one of two keys required to uniquely identify the partition. This property is identical to the ObjectId field of the disk object that contains this partition.'
keyTrue
DiskId property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
DiskNumber property
CIMTYPE'uint32'
Description'The operating system's number for the disk that contains this partition. Disk numbers may not necessarily remain the same across reboots.'
DiskNumber property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 4 namespaces
DriveLetter property
CIMTYPE'char16'
Description'The currently assigned drive letter to the partition. This property is NULL if no drive letter has been assigned.'
DriveLetter property is in 2 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 8 namespaces
GptType property
CIMTYPE'string'
Description'This property indicates the partition's GPT type. This property is only valid when the disk's PartitionStyle property is set to 2 - 'GPT' and will be NULL for all other partition styles.'
Values['System Partition', 'Microsoft Reserved', 'Basic data', 'LDM Metadata', 'LDM Data', 'Microsoft Recovery']
GptType property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
Guid property
CIMTYPE'string'
Description'This property is a string representation of the partition's GPT GUID. This property is only valid if the disk's PartitionStyle property is set to 2 - 'GPT' and will be NULL for all other partition stlyes.'
Guid property is in 2 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 14 namespaces
IsActive property
CIMTYPE'boolean'
Description'Signifies whether or not the partition is active and can be booted. This property is only relevant for MBR disks.'
IsActive property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 4 namespaces
IsHidden property
CIMTYPE'boolean'
Description'If this property is set to TRUE, the partition is not detected by the mount manager. As a result, the partition does not receive a drive letter, does not receive a volume GUID path, does not host volume mount points, and is not enumerated by calls to FindFirstVolume and FindNextVolume. This ensures that applications such as disk defragmenter do not access the partition. The Volume Shadow Copy Service (VSS) uses this attribute on its shadow copies.'
IsHidden property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
IsShadowCopy property
CIMTYPE'boolean'
Description'If this property is set to TRUE, the partition is a shadow copy of another partition. This attribute is used by the Volume Shadow Copy service (VSS). This attribute is an indication for file system filter driver-based software (such as antivirus programs) to avoid attaching to the volume. An application can use this attribute to differentiate a shadow copy partition from a production partition. For example, an application that performs a fast recovery will break a shadow copy virtual disk by clearing the read-only and hidden attributes and this attribute. This attribute is set when the shadow copy is created and cleared when the shadow copy is broken.'
IsShadowCopy property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
MbrType property
CIMTYPE'uint16'
Description'This property indicates the partition's MBR type. This property is only valid when the disk's PartitionStyle property is set to 1 - 'MBR' and will be NULL for all other partition styles.'
Values['FAT12', 'FAT16', 'Extended', 'Huge', 'IFS', 'FAT32']
MbrType property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
NoDefaultDriveLetter property
CIMTYPE'boolean'
Description'If this property is set to TRUE, the operating system does not assign a drive letter automatically when the partition is discovered. This is only honored for GPT disks and is assumed to be FALSE for MBR disks. This attribute is useful in storage area network (SAN) environments.'
NoDefaultDriveLetter property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 2 namespaces
Offset property
CIMTYPE'uint64'
Description'This is the second of two keys required to uniquely identify the partition. This property indicates the partition's offset from the beginning of the disk, measured in bytes.'
keyTrue
Units'Bytes'
Offset property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 5 namespaces
OperationalStatus property
CIMTYPE'uint16'
Values['Unknown', 'Online', 'No Media', 'Failed', 'Offline']
OperationalStatus property is in 10 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 18 namespaces
PartitionNumber property
CIMTYPE'uint32'
Description'The operating system's number for the partition. Ordering is based on the partition's offset, relative to other partitions. This means that the value for this property may change based off of the partition configuration in the offset range preceding this partition.'
PartitionNumber property is in 1 class (MSFT_Partition) of ROOT\Microsoft\Windows\Storage\ms_409 and in 6 namespaces
Size property
CIMTYPE'uint64'
Description'Total size of the partition, measured in bytes.'
Units'Bytes'
Size property is in 8 classes of ROOT\Microsoft\Windows\Storage\ms_409 and in 16 namespaces

MSFT_Partition Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
ClassVersion'1.0'
Description'Represents a partition on a disk.'
LOCALE'MS_409'

MSFT_Partition System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\Storage\ms_409:MSFT_Partition'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\Storage\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT15___SYSTEM3
__RELPATH'MSFT_Partition'___SYSTEM8
__DYNASTY'MSFT_Partition'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'MSFT_Partition'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_Partition

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_DiskToPartition000----
MSFT_PartitionToVolume000----
comments powered by Disqus
WUtils.com