Export (0) Print
Expand All
Expand Minimize

GetKeyProtectors method of the Win32_EncryptableVolume class

The GetKeyProtectors method of the Win32_EncryptableVolume class lists the protectors used to secure the volume's encryption key. If a protector type is provided, then only volume key protectors of the specified type are returned.

Syntax


uint32 GetKeyProtectors(
  [in, optional]  uint32 KeyProtectorType,
  [out]           string VolumeKeyProtectorID[]
);

Parameters

KeyProtectorType [in, optional]

Type: uint32

An unsigned integer that specifies the type of key protector to return.

If this parameter is not specified, all available key protectors of the volume are returned.

ValueMeaning
0

All types.

All key protectors are returned.

1

Trusted Platform Module (TPM).

2

External key.

3

Numeric password.

4

TPM And PIN.

5

TPM And Startup Key.

6

TPM And PIN And Startup Key.

7

Public Key.

8

Passphrase.

9

TPM Certificate

10

Security Identifier (SID)

 

VolumeKeyProtectorID [out]

Type: string[]

An array of strings that identify the key protectors used to secure the volume's encryption key.

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.

E_INVALIDARG
2147942487 (0x80070057)

The VolumeKeyProtectorID parameter is specified but does not refer to a valid KeyProtectorType.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft