Edit

UnlockWithPassphrase method of the Win32_EncryptableVolume class

  • Article

The UnlockWithPassphrase method of the Win32_EncryptableVolume class uses the passphrase to obtain the derived key. After the derived key is calculated, the derived key is used to unlock the encrypted volume's master key.

Note

If the disc supports hardware encryption this function sets the band status to "unlocked""

 

Syntax

uint32 UnlockWithPassphrase(
  [in] string Passphrase
);

Parameters

Passphrase [in]

Type: string

A string that specifies the passphrase.

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_NOT_ACTIVATED
2150694920 (0x80310008)
 BitLocker is not enabled on the volume. Add a key protector to enable BitLocker.
FVE_E_FIPS_PREVENTS_PASSPHRASE
2150695020 (0x8031006C)
 The group policy setting that requires FIPS compliance prevented the passphrase from being generated or used.
FVE_E_POLICY_INVALID_PASSPHRASE_LENGTH
2150695040 (0x80310080)
 The passphrase provided does not meet the minimum or maximum length requirements.
FVE_E_POLICY_PASSPHRASE_TOO_SIMPLE
2150695041 (0x80310081)
 The passphrase does not meet the complexity requirements set by the administrator in group policy.
FVE_E_FAILED_AUTHENTICATION
2150694951 (0x80310027)
 The volume cannot be unlocked with the provided information.
FVE_E_PROTECTOR_NOT_FOUND
2150694963 (0x80310033)
 The provided key protector does not exist on the volume. You must enter another key protector.

 

Requirements

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

See also

Win32_EncryptableVolume