Win32 API 日本語リファレンス
ホームStorage.FileSystem › QueryRecoveryAgentsOnEncryptedFile

QueryRecoveryAgentsOnEncryptedFile

関数
暗号化ファイルの回復エージェント一覧を取得する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

DWORD QueryRecoveryAgentsOnEncryptedFile(
    LPCWSTR lpFileName,
    ENCRYPTION_CERTIFICATE_HASH_LIST** pRecoveryAgents
);

パラメーター

名前方向説明
lpFileNameLPCWSTRinファイルの名前。
pRecoveryAgentsENCRYPTION_CERTIFICATE_HASH_LIST**out回復エージェントの一覧を受け取る ENCRYPTION_CERTIFICATE_HASH_LIST 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

指定したファイルの回復エージェントの一覧を取得します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの完全な一覧については、 システムエラーコード またはヘッダーファイル WinError.h を参照してください。

解説(Remarks)

回復エージェントの一覧が不要になったら、 FreeEncryptionCertificateHashList 関数を呼び出して解放してください。

Windows 8、Windows Server 2012 以降では、この関数は以下のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) いいえ
スケールアウトファイル共有 (SO) を使用した SMB 3.0 いいえ
クラスター共有ボリュームファイルシステム (CsvFS) いいえ
回復性ファイルシステム (ReFS) いいえ

SMB 3.0 は、継続的可用性機能を持つ共有上での EFS をサポートしていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

DWORD QueryRecoveryAgentsOnEncryptedFile(
    LPCWSTR lpFileName,
    ENCRYPTION_CERTIFICATE_HASH_LIST** pRecoveryAgents
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint QueryRecoveryAgentsOnEncryptedFile(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    IntPtr pRecoveryAgents   // ENCRYPTION_CERTIFICATE_HASH_LIST** out
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function QueryRecoveryAgentsOnEncryptedFile(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    pRecoveryAgents As IntPtr   ' ENCRYPTION_CERTIFICATE_HASH_LIST** out
) As UInteger
End Function
' lpFileName : LPCWSTR
' pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out
Declare PtrSafe Function QueryRecoveryAgentsOnEncryptedFile Lib "advapi32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal pRecoveryAgents As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueryRecoveryAgentsOnEncryptedFile = ctypes.windll.advapi32.QueryRecoveryAgentsOnEncryptedFile
QueryRecoveryAgentsOnEncryptedFile.restype = wintypes.DWORD
QueryRecoveryAgentsOnEncryptedFile.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.c_void_p,  # pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
QueryRecoveryAgentsOnEncryptedFile = Fiddle::Function.new(
  lib['QueryRecoveryAgentsOnEncryptedFile'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn QueryRecoveryAgentsOnEncryptedFile(
        lpFileName: *const u16,  // LPCWSTR
        pRecoveryAgents: *mut *mut ENCRYPTION_CERTIFICATE_HASH_LIST  // ENCRYPTION_CERTIFICATE_HASH_LIST** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint QueryRecoveryAgentsOnEncryptedFile([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, IntPtr pRecoveryAgents);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryRecoveryAgentsOnEncryptedFile' -Namespace Win32 -PassThru
# $api::QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
#uselib "ADVAPI32.dll"
#func global QueryRecoveryAgentsOnEncryptedFile "QueryRecoveryAgentsOnEncryptedFile" sptr, sptr
; QueryRecoveryAgentsOnEncryptedFile lpFileName, varptr(pRecoveryAgents)   ; 戻り値は stat
; lpFileName : LPCWSTR -> "sptr"
; pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global QueryRecoveryAgentsOnEncryptedFile "QueryRecoveryAgentsOnEncryptedFile" wstr, var
; res = QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
; lpFileName : LPCWSTR -> "wstr"
; pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD QueryRecoveryAgentsOnEncryptedFile(LPCWSTR lpFileName, ENCRYPTION_CERTIFICATE_HASH_LIST** pRecoveryAgents)
#uselib "ADVAPI32.dll"
#cfunc global QueryRecoveryAgentsOnEncryptedFile "QueryRecoveryAgentsOnEncryptedFile" wstr, var
; res = QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
; lpFileName : LPCWSTR -> "wstr"
; pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procQueryRecoveryAgentsOnEncryptedFile = advapi32.NewProc("QueryRecoveryAgentsOnEncryptedFile")
)

// lpFileName (LPCWSTR), pRecoveryAgents (ENCRYPTION_CERTIFICATE_HASH_LIST** out)
r1, _, err := procQueryRecoveryAgentsOnEncryptedFile.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
	uintptr(pRecoveryAgents),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function QueryRecoveryAgentsOnEncryptedFile(
  lpFileName: PWideChar;   // LPCWSTR
  pRecoveryAgents: Pointer   // ENCRYPTION_CERTIFICATE_HASH_LIST** out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'QueryRecoveryAgentsOnEncryptedFile';
result := DllCall("ADVAPI32\QueryRecoveryAgentsOnEncryptedFile"
    , "WStr", lpFileName   ; LPCWSTR
    , "Ptr", pRecoveryAgents   ; ENCRYPTION_CERTIFICATE_HASH_LIST** out
    , "UInt")   ; return: DWORD
●QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents) = DLL("ADVAPI32.dll", "dword QueryRecoveryAgentsOnEncryptedFile(char*, void*)")
# 呼び出し: QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
# lpFileName : LPCWSTR -> "char*"
# pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn QueryRecoveryAgentsOnEncryptedFile(
    lpFileName: [*c]const u16, // LPCWSTR
    pRecoveryAgents: [*c][*c]ENCRYPTION_CERTIFICATE_HASH_LIST // ENCRYPTION_CERTIFICATE_HASH_LIST** out
) callconv(std.os.windows.WINAPI) u32;
proc QueryRecoveryAgentsOnEncryptedFile(
    lpFileName: WideCString,  # LPCWSTR
    pRecoveryAgents: ptr ENCRYPTION_CERTIFICATE_HASH_LIST  # ENCRYPTION_CERTIFICATE_HASH_LIST** out
): uint32 {.importc: "QueryRecoveryAgentsOnEncryptedFile", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint QueryRecoveryAgentsOnEncryptedFile(
    const(wchar)* lpFileName,   // LPCWSTR
    ENCRYPTION_CERTIFICATE_HASH_LIST** pRecoveryAgents   // ENCRYPTION_CERTIFICATE_HASH_LIST** out
);
ccall((:QueryRecoveryAgentsOnEncryptedFile, "ADVAPI32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{ENCRYPTION_CERTIFICATE_HASH_LIST}),
      lpFileName, pRecoveryAgents)
# lpFileName : LPCWSTR -> Cwstring
# pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> Ptr{ENCRYPTION_CERTIFICATE_HASH_LIST}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t QueryRecoveryAgentsOnEncryptedFile(
    const uint16_t* lpFileName,
    void* pRecoveryAgents);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
-- lpFileName : LPCWSTR
-- pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const QueryRecoveryAgentsOnEncryptedFile = lib.func('__stdcall', 'QueryRecoveryAgentsOnEncryptedFile', 'uint32_t', ['str16', 'void *']);
// QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
// lpFileName : LPCWSTR -> 'str16'
// pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  QueryRecoveryAgentsOnEncryptedFile: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents)
// lpFileName : LPCWSTR -> "buffer"
// pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t QueryRecoveryAgentsOnEncryptedFile(
    const uint16_t* lpFileName,
    void* pRecoveryAgents);
C, "ADVAPI32.dll");
// $ffi->QueryRecoveryAgentsOnEncryptedFile(lpFileName, pRecoveryAgents);
// lpFileName : LPCWSTR
// pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    int QueryRecoveryAgentsOnEncryptedFile(
        WString lpFileName,   // LPCWSTR
        Pointer pRecoveryAgents   // ENCRYPTION_CERTIFICATE_HASH_LIST** out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun QueryRecoveryAgentsOnEncryptedFile = QueryRecoveryAgentsOnEncryptedFile(
    lpFileName : UInt16*,   # LPCWSTR
    pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST**   # ENCRYPTION_CERTIFICATE_HASH_LIST** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueryRecoveryAgentsOnEncryptedFileNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>);
typedef QueryRecoveryAgentsOnEncryptedFileDart = int Function(Pointer<Utf16>, Pointer<Void>);
final QueryRecoveryAgentsOnEncryptedFile = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<QueryRecoveryAgentsOnEncryptedFileNative, QueryRecoveryAgentsOnEncryptedFileDart>('QueryRecoveryAgentsOnEncryptedFile');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueryRecoveryAgentsOnEncryptedFile(
  lpFileName: PWideChar;   // LPCWSTR
  pRecoveryAgents: Pointer   // ENCRYPTION_CERTIFICATE_HASH_LIST** out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'QueryRecoveryAgentsOnEncryptedFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryRecoveryAgentsOnEncryptedFile"
  c_QueryRecoveryAgentsOnEncryptedFile :: CWString -> Ptr () -> IO Word32
-- lpFileName : LPCWSTR -> CWString
-- pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let queryrecoveryagentsonencryptedfile =
  foreign "QueryRecoveryAgentsOnEncryptedFile"
    ((ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("QueryRecoveryAgentsOnEncryptedFile" query-recovery-agents-on-encrypted-file :convention :stdcall) :uint32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-recovery-agents :pointer))   ; ENCRYPTION_CERTIFICATE_HASH_LIST** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueryRecoveryAgentsOnEncryptedFile = Win32::API::More->new('ADVAPI32',
    'DWORD QueryRecoveryAgentsOnEncryptedFile(LPCWSTR lpFileName, LPVOID pRecoveryAgents)');
# my $ret = $QueryRecoveryAgentsOnEncryptedFile->Call($lpFileName, $pRecoveryAgents);
# lpFileName : LPCWSTR -> LPCWSTR
# pRecoveryAgents : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型