GetConversionStatus method of the Win32_EncryptableVolume class

  • Article

The GetConversionStatus method of the Win32_EncryptableVolume class indicates the status of the encryption or decryption on the volume.

Syntax

uint32 GetConversionStatus(
  [out] uint32 ConversionStatus,
  [out] uint32 EncryptionPercentage,
  [out] uint32 EncryptionFlags,
  [out] uint32 WipingStatus,
  [out] uint32 WipingPercentage,
  [in]  uint32 PrecisionFactor
);

Parameters

ConversionStatus [out]

Type: uint32

Volume encryption or decryption status. This can be one of the following values.

Value Meaning
FullyDecrypted
0
 For a standard hard drive (HDD), the volume is fully decrypted.
For a hardware encrypted hard drive (EHDD), the volume is perpetually unlocked.
FullyEncrypted
1
 For a standard hard drive (HDD), the volume is fully encrypted.
For a hardware encrypted hard drive (EHDD), the volume is not perpetually unlocked.
EncryptionInProgress
2
 The volume is partially encrypted.
DecryptionInProgress
3
 The volume is partially encrypted.
EncryptionPaused
4
 The volume has been paused during the encryption progress. The volume is partially encrypted.
DecryptionPaused
5
 The volume has been paused during the decryption progress. The volume is partially encrypted.

 

EncryptionPercentage [out]

Type: uint32

Percentage of the volume that is encrypted. This is an integer from 0 to 100 inclusive.

Due to rounding of numbers, an encryption percentage of 0 or 100 does not necessarily indicate that the disk is fully decrypted or fully encrypted. Always use ConversionStatus to determine whether the disk is in fact fully decrypted or fully encrypted.

EncryptionFlags [out]

Type: uint32

Flags that describe the encryption behavior.

A combination of 32 bits with following bits currently defined.

Value Meaning
0x00000001
 Perform volume encryption in data-only encryption mode when starting new encryption process. If encryption has been paused or stopped, calling the Encrypt method effectively resumes conversion and the value of this bit is ignored. This bit only has effect when either the Encrypt or EncryptAfterHardwareTest methods start encryption from the fully decrypted state, decryption in progress state, or decryption paused state. If this bit is zero, meaning that it is not set, when starting new encryption process, then full mode conversion will be performed.
0x00000002
 Perform on-demand wipe of the volume free space. Calling the Encrypt method with this bit set is only allowed when volume is not currently converting or wiping and is in an "encrypted" state.
0x00010000
Perform the requested operation synchronously. The call will block until requested operation has completed or was interrupted. This flag is only supported with the Encrypt method. This flag can be specified when Encrypt is called to resume stopped or interrupted encryption or wiping or when either encryption or wiping is in progress. This allows the caller to resume synchronously waiting until the process is completed or interrupted.

 

WipingStatus [out]

Type: uint32

Free space wiping status. This can be one of the following values.

Value Meaning
FreeSpaceNotWiped
0
 The free space has not been wiped.
FreeSpaceWiped
1
 The free space has been wiped.
FreeSpaceWipingInProgress
2
 Free space wiping is currently in progress.
FreeSpaceWipingPaused
3
 Free space wiping has been paused.

 

WipingPercentage [out]

Type: uint32

A value from 0 to 100 that specifies the percentage of free space that has been wiped.

PrecisionFactor [in]

Type: uint32

A value from 0 to 4 that specifies the precision level

Return value

Type: uint32

This method returns one of the following codes or another error code if it fails.

Return code/value Description
S_OK
0 (0x0)
 The method was successful.
FVE_E_LOCKED_VOLUME
2150694912 (0x80310000)
 The volume is locked.

 

Remarks

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Windows SDK. They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement Value
Minimum supported client
 Windows Vista Enterprise, Windows Vista Ultimate [desktop apps only]
Minimum supported server
 Windows Server 2008 [desktop apps only]
Namespace
 Root\CIMV2\Security\MicrosoftVolumeEncryption
MOF
Win32_encryptablevolume.mof

See also

Win32_EncryptableVolume