QueryRecoveryAgentsOnEncryptedFile function (winefs.h)
Retrieves a list of recovery agents for the specified file.
Syntax
DWORD QueryRecoveryAgentsOnEncryptedFile(
[in] LPCWSTR lpFileName,
[out] PENCRYPTION_CERTIFICATE_HASH_LIST *pRecoveryAgents
);
Parameters
[in] lpFileName
The name of the file.
[out] pRecoveryAgents
A pointer to a ENCRYPTION_CERTIFICATE_HASH_LIST structure that receives a list of recovery agents.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value is a system error code. For a complete list of error codes, see System Error Codes or the header file WinError.h.
Remarks
When the list of recovery agents is no longer needed, free it by calling the FreeEncryptionCertificateHashList function.
In Windows 8, Windows Server 2012, and later, this function is supported by the following technologies.
| Technology | Supported |
|---|---|
| Server Message Block (SMB) 3.0 protocol | Yes |
| SMB 3.0 Transparent Failover (TFO) | No |
| SMB 3.0 with Scale-out File Shares (SO) | No |
| Cluster Shared Volume File System (CsvFS) | No |
| Resilient File System (ReFS) | No |
SMB 3.0 does not support EFS on shares with continuous availability capability.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP Professional [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | winefs.h (include Windows.h) |
| Library | Advapi32.lib |
| DLL | Advapi32.dll |
| API set | ext-ms-win-advapi32-encryptedfile-l1-1-1 (introduced in Windows 10, version 10.0.14393) |