Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

GetKeyProtectorExternalKey method of the Win32_EncryptableVolume class

The GetKeyProtectorExternalKey method of the Win32_EncryptableVolume class retrieves the external key for a given key protector of the appropriate type.

The key protector identifier must refer to a key protector of type "External Key", "TPM And PIN And Startup Key", or "TPM And Startup Key".

Syntax


uint32 GetKeyProtectorExternalKey(
  [in]   string VolumeKeyProtectorID,
  [out]  uint8 ExternalKey[]
);

Parameters

VolumeKeyProtectorID [in]

Type: string

A unique string identifier used to manage an encrypted volume key protector.

ExternalKey [out]

Type: uint8[]

An array of bytes that specifies the 256-bit external key that can be used to unlock the corresponding volume.

Return value

Type: uint32

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

Return code/valueDescription
S_OK
0 (0x0)

The method was successful.

FVE_E_LOCKED_VOLUME
2150694912 (0x80310000)

The volume is locked.

E_INVALIDARG
2147942487 (0x80070057)

The VolumeKeyProtectorID parameter does not refer to a key protector of the type "External Key", "TPM And PIN And Startup Key", or "TPM And Startup Key".

FVE_E_NOT_ACTIVATED
2150694920 (0x80310008)

BitLocker is not enabled on the volume. Add a key protector to enable BitLocker.

 

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

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

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.