IsKeyProtectorAvailable method of the Win32_EncryptableVolume class

The IsKeyProtectorAvailable method of the Win32_EncryptableVolume class indicates whether protectors are available for the volume.

If a protector type is provided, then the method indicates whether protectors of the specified type are available for the volume.

Syntax

uint32 IsKeyProtectorAvailable(
  [in, optional] uint32  KeyProtectorType,
  [out]          boolean IsKeyProtectorAvailable
);

Parameters

KeyProtectorType [in, optional]

Type: uint32

An unsigned integer that indicates the type of volume key protector queried.

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

Value Meaning
0
All types.
All key protectors are queried.
1
Trusted Platform Module (TPM).
2
External key.
3
Numerical 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)

 

IsKeyProtectorAvailable [out]

Type: boolean

A Boolean value that indicates whether a volume key protector of the specified type exists on the volume.

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.
E_INVALIDARG
2147942487 (0x80070057)
The KeyProtectorType parameter is specified but does not refer to a valid key protector type.

 

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