GetExternalKeyFileName method of the Win32_EncryptableVolume class

Article
01/07/2021

The GetExternalKeyFileName method of the Win32_EncryptableVolume class returns the name of the file that contains the external key, if this external key is saved to a file location by using the SaveExternalKeyToFile method.

This method is only applicable for key protectors of the type "External Key", "TPM And PIN And Startup Key", or "TPM And Startup Key".

Syntax

uint32 GetExternalKeyFileName(
  [in]  string VolumeKeyProtectorID,
  [out] string FileName
);

Parameters

VolumeKeyProtectorID [in]

Type: string

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

FileName [out]

Type: string

A string that specifies the name with extension but without the file path, of the file that contains the external key.

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 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_LOCKED_VOLUME 2150694912 (0x80310000)	The volume is locked.
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

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