EncryptFileW
関数シグネチャ
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
BOOL EncryptFileW(
LPCWSTR lpFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileName | LPCWSTR | in | 暗号化するファイルまたはディレクトリの名前。 呼び出し元は、FILE_READ_DATA、FILE_WRITE_DATA、 FILE_READ_ATTRIBUTES、FILE_WRITE_ATTRIBUTES、および SYNCHRONIZE のアクセス権を持っている必要があります。詳細については、 File Security and Access Rights を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
ファイルまたはディレクトリを暗号化します。(Unicode)
戻り値
関数が成功した場合、戻り値は 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 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 ヘッダーは EncryptFile を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディングニュートラルなエイリアスの使用を、エンコーディングニュートラルでないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
BOOL EncryptFileW(
LPCWSTR lpFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool EncryptFileW(
[MarshalAs(UnmanagedType.LPWStr)] string lpFileName // LPCWSTR
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EncryptFileW(
<MarshalAs(UnmanagedType.LPWStr)> lpFileName As String ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpFileName : LPCWSTR
Declare PtrSafe Function EncryptFileW Lib "advapi32" ( _
ByVal lpFileName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
EncryptFileW = ctypes.windll.advapi32.EncryptFileW
EncryptFileW.restype = wintypes.BOOL
EncryptFileW.argtypes = [
wintypes.LPCWSTR, # lpFileName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
EncryptFileW = Fiddle::Function.new(
lib['EncryptFileW'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCWSTR
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "advapi32")]
extern "system" {
fn EncryptFileW(
lpFileName: *const u16 // LPCWSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool EncryptFileW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EncryptFileW' -Namespace Win32 -PassThru
# $api::EncryptFileW(lpFileName)#uselib "ADVAPI32.dll"
#func global EncryptFileW "EncryptFileW" wptr
; EncryptFileW lpFileName ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global EncryptFileW "EncryptFileW" wstr
; res = EncryptFileW(lpFileName)
; lpFileName : LPCWSTR -> "wstr"; BOOL EncryptFileW(LPCWSTR lpFileName)
#uselib "ADVAPI32.dll"
#cfunc global EncryptFileW "EncryptFileW" wstr
; res = EncryptFileW(lpFileName)
; lpFileName : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procEncryptFileW = advapi32.NewProc("EncryptFileW")
)
// lpFileName (LPCWSTR)
r1, _, err := procEncryptFileW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction EncryptFileW(
lpFileName: PWideChar // LPCWSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'EncryptFileW';result := DllCall("ADVAPI32\EncryptFileW"
, "WStr", lpFileName ; LPCWSTR
, "Int") ; return: BOOL●EncryptFileW(lpFileName) = DLL("ADVAPI32.dll", "bool EncryptFileW(char*)")
# 呼び出し: EncryptFileW(lpFileName)
# lpFileName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "advapi32" fn EncryptFileW(
lpFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc EncryptFileW(
lpFileName: WideCString # LPCWSTR
): int32 {.importc: "EncryptFileW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "advapi32");
extern(Windows)
int EncryptFileW(
const(wchar)* lpFileName // LPCWSTR
);ccall((:EncryptFileW, "ADVAPI32.dll"), stdcall, Int32,
(Cwstring,),
lpFileName)
# lpFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t EncryptFileW(
const uint16_t* lpFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.EncryptFileW(lpFileName)
-- lpFileName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const EncryptFileW = lib.func('__stdcall', 'EncryptFileW', 'int32_t', ['str16']);
// EncryptFileW(lpFileName)
// lpFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
EncryptFileW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.EncryptFileW(lpFileName)
// lpFileName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t EncryptFileW(
const uint16_t* lpFileName);
C, "ADVAPI32.dll");
// $ffi->EncryptFileW(lpFileName);
// lpFileName : LPCWSTR
// 構造体/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.UNICODE_OPTIONS);
boolean EncryptFileW(
WString lpFileName // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("advapi32")]
lib LibADVAPI32
fun EncryptFileW = EncryptFileW(
lpFileName : UInt16* # LPCWSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef EncryptFileWNative = Int32 Function(Pointer<Utf16>);
typedef EncryptFileWDart = int Function(Pointer<Utf16>);
final EncryptFileW = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<EncryptFileWNative, EncryptFileWDart>('EncryptFileW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EncryptFileW(
lpFileName: PWideChar // LPCWSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'EncryptFileW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EncryptFileW"
c_EncryptFileW :: CWString -> IO CInt
-- lpFileName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let encryptfilew =
foreign "EncryptFileW"
((ptr uint16_t) @-> returning int32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("EncryptFileW" encrypt-file-w :convention :stdcall) :int32
(lp-file-name (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EncryptFileW = Win32::API::More->new('ADVAPI32',
'BOOL EncryptFileW(LPCWSTR lpFileName)');
# my $ret = $EncryptFileW->Call($lpFileName);
# lpFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f EncryptFileA (ANSI版) — 指定ファイルをEFSにより暗号化する(ANSI版)。
- f DecryptFileW — EFSで暗号化されたファイルを復号する(Unicode版)。