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

DecryptFileA

関数
EFSで暗号化されたファイルを復号する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL DecryptFileA(
    LPCSTR lpFileName,
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

復号するファイルまたはディレクトリの名前。

呼び出し元は、FILE_READ_DATAFILE_WRITE_DATAFILE_READ_ATTRIBUTESFILE_WRITE_ATTRIBUTES、および SYNCHRONIZE のアクセス権を持っている必要があります。詳細については、 File Security and Access Rights を参照してください。

dwReservedDWORDoptional予約済み。ゼロを指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

暗号化されたファイルまたはディレクトリを復号します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

DecryptFile 関数は復号対象のファイルへの排他アクセスを必要とし、別のプロセスがそのファイルを使用している場合は失敗します。ファイルが暗号化されていない場合、 DecryptFile は単に 0 以外の値を返し、成功を示します。

lpFileName が読み取り専用ファイルを指定している場合、関数は失敗し、GetLastErrorERROR_FILE_READ_ONLY を返します。lpFileName が読み取り専用ファイルを含むディレクトリを指定している場合、関数は成功しますが、ディレクトリは復号されません。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) いいえ
SMB 3.0 with Scale-out File Shares (SO) いいえ
Cluster Shared Volume File System (CsvFS) いいえ
Resilient File System (ReFS) いいえ

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

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DecryptFile を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL DecryptFileA(
    LPCSTR lpFileName,
    DWORD dwReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DecryptFileA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    uint dwReserved   // DWORD optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DecryptFileA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    dwReserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCSTR
' dwReserved : DWORD optional
Declare PtrSafe Function DecryptFileA Lib "advapi32" ( _
    ByVal lpFileName As String, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DecryptFileA = ctypes.windll.advapi32.DecryptFileA
DecryptFileA.restype = wintypes.BOOL
DecryptFileA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.DWORD,  # dwReserved : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
DecryptFileA = Fiddle::Function.new(
  lib['DecryptFileA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn DecryptFileA(
        lpFileName: *const u8,  // LPCSTR
        dwReserved: u32  // DWORD optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DecryptFileA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_DecryptFileA' -Namespace Win32 -PassThru
# $api::DecryptFileA(lpFileName, dwReserved)
#uselib "ADVAPI32.dll"
#func global DecryptFileA "DecryptFileA" sptr, sptr
; DecryptFileA lpFileName, dwReserved   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global DecryptFileA "DecryptFileA" str, int
; res = DecryptFileA(lpFileName, dwReserved)
; lpFileName : LPCSTR -> "str"
; dwReserved : DWORD optional -> "int"
; BOOL DecryptFileA(LPCSTR lpFileName, DWORD dwReserved)
#uselib "ADVAPI32.dll"
#cfunc global DecryptFileA "DecryptFileA" str, int
; res = DecryptFileA(lpFileName, dwReserved)
; lpFileName : LPCSTR -> "str"
; dwReserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procDecryptFileA = advapi32.NewProc("DecryptFileA")
)

// lpFileName (LPCSTR), dwReserved (DWORD optional)
r1, _, err := procDecryptFileA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DecryptFileA(
  lpFileName: PAnsiChar;   // LPCSTR
  dwReserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'DecryptFileA';
result := DllCall("ADVAPI32\DecryptFileA"
    , "AStr", lpFileName   ; LPCSTR
    , "UInt", dwReserved   ; DWORD optional
    , "Int")   ; return: BOOL
●DecryptFileA(lpFileName, dwReserved) = DLL("ADVAPI32.dll", "bool DecryptFileA(char*, dword)")
# 呼び出し: DecryptFileA(lpFileName, dwReserved)
# lpFileName : LPCSTR -> "char*"
# dwReserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn DecryptFileA(
    lpFileName: [*c]const u8, // LPCSTR
    dwReserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;
proc DecryptFileA(
    lpFileName: cstring,  # LPCSTR
    dwReserved: uint32  # DWORD optional
): int32 {.importc: "DecryptFileA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int DecryptFileA(
    const(char)* lpFileName,   // LPCSTR
    uint dwReserved   // DWORD optional
);
ccall((:DecryptFileA, "ADVAPI32.dll"), stdcall, Int32,
      (Cstring, UInt32),
      lpFileName, dwReserved)
# lpFileName : LPCSTR -> Cstring
# dwReserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DecryptFileA(
    const char* lpFileName,
    uint32_t dwReserved);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.DecryptFileA(lpFileName, dwReserved)
-- lpFileName : LPCSTR
-- dwReserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const DecryptFileA = lib.func('__stdcall', 'DecryptFileA', 'int32_t', ['str', 'uint32_t']);
// DecryptFileA(lpFileName, dwReserved)
// lpFileName : LPCSTR -> 'str'
// dwReserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  DecryptFileA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.DecryptFileA(lpFileName, dwReserved)
// lpFileName : LPCSTR -> "buffer"
// dwReserved : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DecryptFileA(
    const char* lpFileName,
    uint32_t dwReserved);
C, "ADVAPI32.dll");
// $ffi->DecryptFileA(lpFileName, dwReserved);
// lpFileName : LPCSTR
// dwReserved : DWORD optional
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    boolean DecryptFileA(
        String lpFileName,   // LPCSTR
        int dwReserved   // DWORD optional
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun DecryptFileA = DecryptFileA(
    lpFileName : UInt8*,   # LPCSTR
    dwReserved : UInt32   # DWORD optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DecryptFileANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef DecryptFileADart = int Function(Pointer<Utf8>, int);
final DecryptFileA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<DecryptFileANative, DecryptFileADart>('DecryptFileA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// dwReserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DecryptFileA(
  lpFileName: PAnsiChar;   // LPCSTR
  dwReserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'DecryptFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DecryptFileA"
  c_DecryptFileA :: CString -> Word32 -> IO CInt
-- lpFileName : LPCSTR -> CString
-- dwReserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let decryptfilea =
  foreign "DecryptFileA"
    (string @-> uint32_t @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* dwReserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("DecryptFileA" decrypt-file-a :convention :stdcall) :int32
  (lp-file-name :string)   ; LPCSTR
  (dw-reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DecryptFileA = Win32::API::More->new('ADVAPI32',
    'BOOL DecryptFileA(LPCSTR lpFileName, DWORD dwReserved)');
# my $ret = $DecryptFileA->Call($lpFileName, $dwReserved);
# lpFileName : LPCSTR -> LPCSTR
# dwReserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目