UnlockWithCertificateThumbprint method of the Win32_EncryptableVolume class
The UnlockWithCertificateThumbprint method of the Win32_EncryptableVolume class uses the provided certificate thumbprint to obtain the derived key and unlock the encrypted volume.
Note
If the disc supports hardware encryption this function sets the band status to "unlocked""
Syntax
uint32 UnlockWithCertificateThumbprint(
[in] string CertThumbprint,
[in] string PIN
);
Parameters
-
CertThumbprint [in]
-
Type: string
A thumbprint value of 0 is accepted and results in a search of the local store for the appropriate certificate. If a single BitLocker certificate is found, the search is successful. If none or more than one certificate is found, the method fails.
-
PIN [in]
-
Type: string
A user-specified personal identification string. This string must consist of a sequence of 4 to 20 digits. This string is used to silently authenticate the key storage provider (KSP) when used with a smart card.
Return value
Type: uint32
This method returns one of the following codes or another error code if it fails.
| Return code/value | Description |
|---|---|
|
The method was successful. |
|
BitLocker is not enabled on the volume. Add a key protector to enable BitLocker. |
|
The volume cannot be unlocked by using the provided information. |
|
The provided key protector does not exist on the volume. You must enter another key protector. |
|
The private key associated with the specified certificate could not be authorized. The private key authorization was either not provided or the provided authorization was not valid. |
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 |
|
See also