EncryptFileA
関数シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL EncryptFileA(
LPCSTR lpFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileName | LPCSTR | in | 暗号化するファイルまたはディレクトリの名前。 呼び出し元は FILE_READ_DATA、FILE_WRITE_DATA、 FILE_READ_ATTRIBUTES、FILE_WRITE_ATTRIBUTES、および SYNCHRONIZE のアクセス権を持っている必要があります。詳細については、 File Security and Access Rights を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
ファイルまたはディレクトリを暗号化します。(ANSI)
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
EncryptFile 関数は、暗号化対象のファイルへの排他アクセスを必要とし、 他のプロセスがそのファイルを使用している場合は失敗します。
ファイルが既に暗号化されている場合、EncryptFile は単純に 0 以外の値を返し、成功を示します。ファイルが圧縮されている場合、 EncryptFile は暗号化する前にファイルを解凍します。
lpFileName が読み取り専用ファイルを指定している場合、関数は失敗し、 GetLastError は ERROR_FILE_READ_ONLY を返します。lpFileName が読み取り専用ファイルを含む ディレクトリを指定している場合、関数は成功しますが、ディレクトリは暗号化されません。
暗号化されたファイルを復号するには、 DecryptFile 関数を使用します。
Windows 8、Windows Server 2012 以降では、この関数は以下のテクノロジでサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 トランスペアレント フェールオーバー (TFO) | いいえ |
| SMB 3.0 とスケールアウト ファイル共有 (SO) | いいえ |
| クラスターの共有ボリューム ファイル システム (CsvFS) | いいえ |
| 回復性のあるファイル システム (ReFS) | いいえ |
SMB 3.0 は、継続的可用性機能を持つ共有上での EFS をサポートしていません。
winbase.h ヘッダーは EncryptFile を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイル エラーやランタイム エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL EncryptFileA(
LPCSTR lpFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EncryptFileA(
[MarshalAs(UnmanagedType.LPStr)] string lpFileName // LPCSTR
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EncryptFileA(
<MarshalAs(UnmanagedType.LPStr)> lpFileName As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpFileName : LPCSTR
Declare PtrSafe Function EncryptFileA Lib "advapi32" ( _
ByVal lpFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
EncryptFileA = ctypes.windll.advapi32.EncryptFileA
EncryptFileA.restype = wintypes.BOOL
EncryptFileA.argtypes = [
wintypes.LPCSTR, # lpFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
EncryptFileA = Fiddle::Function.new(
lib['EncryptFileA'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn EncryptFileA(
lpFileName: *const u8 // LPCSTR
) -> 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 EncryptFileA([MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EncryptFileA' -Namespace Win32 -PassThru
# $api::EncryptFileA(lpFileName)#uselib "ADVAPI32.dll"
#func global EncryptFileA "EncryptFileA" sptr
; EncryptFileA lpFileName ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global EncryptFileA "EncryptFileA" str
; res = EncryptFileA(lpFileName)
; lpFileName : LPCSTR -> "str"; BOOL EncryptFileA(LPCSTR lpFileName)
#uselib "ADVAPI32.dll"
#cfunc global EncryptFileA "EncryptFileA" str
; res = EncryptFileA(lpFileName)
; lpFileName : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procEncryptFileA = advapi32.NewProc("EncryptFileA")
)
// lpFileName (LPCSTR)
r1, _, err := procEncryptFileA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction EncryptFileA(
lpFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'EncryptFileA';result := DllCall("ADVAPI32\EncryptFileA"
, "AStr", lpFileName ; LPCSTR
, "Int") ; return: BOOL●EncryptFileA(lpFileName) = DLL("ADVAPI32.dll", "bool EncryptFileA(char*)")
# 呼び出し: EncryptFileA(lpFileName)
# lpFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn EncryptFileA(
lpFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc EncryptFileA(
lpFileName: cstring # LPCSTR
): int32 {.importc: "EncryptFileA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
int EncryptFileA(
const(char)* lpFileName // LPCSTR
);ccall((:EncryptFileA, "ADVAPI32.dll"), stdcall, Int32,
(Cstring,),
lpFileName)
# lpFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t EncryptFileA(
const char* lpFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.EncryptFileA(lpFileName)
-- lpFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const EncryptFileA = lib.func('__stdcall', 'EncryptFileA', 'int32_t', ['str']);
// EncryptFileA(lpFileName)
// lpFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
EncryptFileA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.EncryptFileA(lpFileName)
// lpFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t EncryptFileA(
const char* lpFileName);
C, "ADVAPI32.dll");
// $ffi->EncryptFileA(lpFileName);
// lpFileName : LPCSTR
// 構造体/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 EncryptFileA(
String lpFileName // LPCSTR
);
}@[Link("advapi32")]
lib LibADVAPI32
fun EncryptFileA = EncryptFileA(
lpFileName : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef EncryptFileANative = Int32 Function(Pointer<Utf8>);
typedef EncryptFileADart = int Function(Pointer<Utf8>);
final EncryptFileA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<EncryptFileANative, EncryptFileADart>('EncryptFileA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EncryptFileA(
lpFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'EncryptFileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EncryptFileA"
c_EncryptFileA :: CString -> IO CInt
-- lpFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let encryptfilea =
foreign "EncryptFileA"
(string @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("EncryptFileA" encrypt-file-a :convention :stdcall) :int32
(lp-file-name :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EncryptFileA = Win32::API::More->new('ADVAPI32',
'BOOL EncryptFileA(LPCSTR lpFileName)');
# my $ret = $EncryptFileA->Call($lpFileName);
# lpFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f EncryptFileW (Unicode版) — 指定ファイルをEFSにより暗号化する(Unicode版)。
- f DecryptFileA — EFSで暗号化されたファイルを復号する(ANSI版)。