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

WriteEncryptedFileRaw

関数
暗号化ファイルの生データをコールバック経由で書き込む。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD WriteEncryptedFileRaw(
    PFE_IMPORT_FUNC pfImportCallback,
    void* pvCallbackContext,   // optional
    void* pvContext
);

パラメーター

名前方向説明
pfImportCallbackPFE_IMPORT_FUNCinインポートコールバック関数へのポインターです。システムはこのコールバック関数を複数回呼び出し、その都度、バックアップされたファイルのデータの一部でコールバック関数によって満たされるバッファーを渡します。コールバック関数がファイル全体の処理完了を通知すると、復元操作が終了したことがシステムに伝えられます。詳細については、ImportCallback を参照してください。
pvCallbackContextvoid*inoptionalアプリケーションが定義し割り当てたコンテキストブロックへのポインターです。システムはこのポインターをパラメーターとしてコールバック関数に渡すため、コールバック関数はアプリケーション固有のデータにアクセスできます。これは構造体でもよく、暗号化ファイルのバックアップコピーを格納するファイルのハンドルなど、アプリケーションが必要とする任意のデータを含めることができます。
pvContextvoid*inシステム定義のコンテキストブロックへのポインターです。コンテキストブロックは OpenEncryptedFileRaw 関数によって返されます。変更しないでください。

戻り値の型: DWORD

公式ドキュメント

暗号化されたファイルを復元(インポート)します。

戻り値

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

関数が失敗した場合は、WinError.h で定義されている 0 以外のエラーコードを返します。FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage を使用すると、エラーの一般的なテキストによる説明を取得できます。

解説(Remarks)

復元されるファイルは復号されません。暗号化された状態のまま復元されます。

暗号化ファイルをバックアップするには、OpenEncryptedFileRaw を呼び出してファイルを開きます。次に、アプリケーション定義のエクスポートコールバック関数のアドレスを渡して ReadEncryptedFileRaw を呼び出します。システムはこのコールバック関数を、ファイル全体の内容が読み取られバックアップされるまで複数回呼び出します。バックアップが完了したら、CloseEncryptedFileRaw を呼び出してリソースを解放し、ファイルを閉じます。エクスポートコールバック関数の宣言方法の詳細については、ExportCallback を参照してください。

暗号化ファイルを復元するには、ulFlags パラメーターに CREATE_FOR_IMPORT を指定して OpenEncryptedFileRaw を呼び出します。次に、アプリケーション定義のインポートコールバック関数のアドレスを渡して WriteEncryptedFileRaw を呼び出します。システムはこのコールバック関数を、ファイル全体の内容が読み取られ復元されるまで複数回呼び出します。復元が完了したら、CloseEncryptedFileRaw を呼び出してリソースを解放し、ファイルを閉じます。インポートコールバック関数の宣言方法の詳細については、ImportCallback を参照してください。

ファイルがスパースファイルであり、復元先のボリュームよりもスパース割り当て単位サイズが小さいボリュームからバックアップされたものである場合、ファイル中央のスパースブロックがより大きいブロックと正しく整列せず、関数呼び出しが失敗して ERROR_INVALID_PARAMETER の最終エラーコードが設定されることがあります。スパース割り当て単位サイズは、16 クラスターまたは 64 KB のいずれか小さい方です。

この関数は暗号化されたファイルのみの復元を目的としています。暗号化されていないファイルの復元については、BackupWrite を参照してください。

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 WriteEncryptedFileRaw(
    PFE_IMPORT_FUNC pfImportCallback,
    void* pvCallbackContext,   // optional
    void* pvContext
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint WriteEncryptedFileRaw(
    IntPtr pfImportCallback,   // PFE_IMPORT_FUNC
    IntPtr pvCallbackContext,   // void* optional
    IntPtr pvContext   // void*
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function WriteEncryptedFileRaw(
    pfImportCallback As IntPtr,   ' PFE_IMPORT_FUNC
    pvCallbackContext As IntPtr,   ' void* optional
    pvContext As IntPtr   ' void*
) As UInteger
End Function
' pfImportCallback : PFE_IMPORT_FUNC
' pvCallbackContext : void* optional
' pvContext : void*
Declare PtrSafe Function WriteEncryptedFileRaw Lib "advapi32" ( _
    ByVal pfImportCallback As LongPtr, _
    ByVal pvCallbackContext As LongPtr, _
    ByVal pvContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WriteEncryptedFileRaw = ctypes.windll.advapi32.WriteEncryptedFileRaw
WriteEncryptedFileRaw.restype = wintypes.DWORD
WriteEncryptedFileRaw.argtypes = [
    ctypes.c_void_p,  # pfImportCallback : PFE_IMPORT_FUNC
    ctypes.POINTER(None),  # pvCallbackContext : void* optional
    ctypes.POINTER(None),  # pvContext : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
WriteEncryptedFileRaw = Fiddle::Function.new(
  lib['WriteEncryptedFileRaw'],
  [
    Fiddle::TYPE_VOIDP,  # pfImportCallback : PFE_IMPORT_FUNC
    Fiddle::TYPE_VOIDP,  # pvCallbackContext : void* optional
    Fiddle::TYPE_VOIDP,  # pvContext : void*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn WriteEncryptedFileRaw(
        pfImportCallback: *const core::ffi::c_void,  // PFE_IMPORT_FUNC
        pvCallbackContext: *mut (),  // void* optional
        pvContext: *mut ()  // void*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint WriteEncryptedFileRaw(IntPtr pfImportCallback, IntPtr pvCallbackContext, IntPtr pvContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_WriteEncryptedFileRaw' -Namespace Win32 -PassThru
# $api::WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
#uselib "ADVAPI32.dll"
#func global WriteEncryptedFileRaw "WriteEncryptedFileRaw" sptr, sptr, sptr
; WriteEncryptedFileRaw pfImportCallback, pvCallbackContext, pvContext   ; 戻り値は stat
; pfImportCallback : PFE_IMPORT_FUNC -> "sptr"
; pvCallbackContext : void* optional -> "sptr"
; pvContext : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global WriteEncryptedFileRaw "WriteEncryptedFileRaw" sptr, sptr, sptr
; res = WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
; pfImportCallback : PFE_IMPORT_FUNC -> "sptr"
; pvCallbackContext : void* optional -> "sptr"
; pvContext : void* -> "sptr"
; DWORD WriteEncryptedFileRaw(PFE_IMPORT_FUNC pfImportCallback, void* pvCallbackContext, void* pvContext)
#uselib "ADVAPI32.dll"
#cfunc global WriteEncryptedFileRaw "WriteEncryptedFileRaw" intptr, intptr, intptr
; res = WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
; pfImportCallback : PFE_IMPORT_FUNC -> "intptr"
; pvCallbackContext : void* optional -> "intptr"
; pvContext : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procWriteEncryptedFileRaw = advapi32.NewProc("WriteEncryptedFileRaw")
)

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

extern "advapi32" fn WriteEncryptedFileRaw(
    pfImportCallback: ?*anyopaque, // PFE_IMPORT_FUNC
    pvCallbackContext: ?*anyopaque, // void* optional
    pvContext: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) u32;
proc WriteEncryptedFileRaw(
    pfImportCallback: pointer,  # PFE_IMPORT_FUNC
    pvCallbackContext: pointer,  # void* optional
    pvContext: pointer  # void*
): uint32 {.importc: "WriteEncryptedFileRaw", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint WriteEncryptedFileRaw(
    void* pfImportCallback,   // PFE_IMPORT_FUNC
    void* pvCallbackContext,   // void* optional
    void* pvContext   // void*
);
ccall((:WriteEncryptedFileRaw, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      pfImportCallback, pvCallbackContext, pvContext)
# pfImportCallback : PFE_IMPORT_FUNC -> Ptr{Cvoid}
# pvCallbackContext : void* optional -> Ptr{Cvoid}
# pvContext : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WriteEncryptedFileRaw(
    void* pfImportCallback,
    void* pvCallbackContext,
    void* pvContext);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
-- pfImportCallback : PFE_IMPORT_FUNC
-- pvCallbackContext : void* optional
-- pvContext : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const WriteEncryptedFileRaw = lib.func('__stdcall', 'WriteEncryptedFileRaw', 'uint32_t', ['void *', 'void *', 'void *']);
// WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
// pfImportCallback : PFE_IMPORT_FUNC -> 'void *'
// pvCallbackContext : void* optional -> 'void *'
// pvContext : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ADVAPI32.dll", {
  WriteEncryptedFileRaw: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext)
// pfImportCallback : PFE_IMPORT_FUNC -> "pointer"
// pvCallbackContext : void* optional -> "pointer"
// pvContext : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WriteEncryptedFileRaw(
    void* pfImportCallback,
    void* pvCallbackContext,
    void* pvContext);
C, "ADVAPI32.dll");
// $ffi->WriteEncryptedFileRaw(pfImportCallback, pvCallbackContext, pvContext);
// pfImportCallback : PFE_IMPORT_FUNC
// pvCallbackContext : void* optional
// pvContext : void*
// 構造体/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 WriteEncryptedFileRaw(
        Callback pfImportCallback,   // PFE_IMPORT_FUNC
        Pointer pvCallbackContext,   // void* optional
        Pointer pvContext   // void*
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun WriteEncryptedFileRaw = WriteEncryptedFileRaw(
    pfImportCallback : Void*,   # PFE_IMPORT_FUNC
    pvCallbackContext : Void*,   # void* optional
    pvContext : Void*   # void*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WriteEncryptedFileRawNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WriteEncryptedFileRawDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WriteEncryptedFileRaw = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<WriteEncryptedFileRawNative, WriteEncryptedFileRawDart>('WriteEncryptedFileRaw');
// pfImportCallback : PFE_IMPORT_FUNC -> Pointer<Void>
// pvCallbackContext : void* optional -> Pointer<Void>
// pvContext : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteEncryptedFileRaw(
  pfImportCallback: Pointer;   // PFE_IMPORT_FUNC
  pvCallbackContext: Pointer;   // void* optional
  pvContext: Pointer   // void*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'WriteEncryptedFileRaw';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteEncryptedFileRaw"
  c_WriteEncryptedFileRaw :: Ptr () -> Ptr () -> Ptr () -> IO Word32
-- pfImportCallback : PFE_IMPORT_FUNC -> Ptr ()
-- pvCallbackContext : void* optional -> Ptr ()
-- pvContext : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let writeencryptedfileraw =
  foreign "WriteEncryptedFileRaw"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* pfImportCallback : PFE_IMPORT_FUNC -> (ptr void) *)
(* pvCallbackContext : void* optional -> (ptr void) *)
(* pvContext : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("WriteEncryptedFileRaw" write-encrypted-file-raw :convention :stdcall) :uint32
  (pf-import-callback :pointer)   ; PFE_IMPORT_FUNC
  (pv-callback-context :pointer)   ; void* optional
  (pv-context :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteEncryptedFileRaw = Win32::API::More->new('ADVAPI32',
    'DWORD WriteEncryptedFileRaw(LPVOID pfImportCallback, LPVOID pvCallbackContext, LPVOID pvContext)');
# my $ret = $WriteEncryptedFileRaw->Call($pfImportCallback, $pvCallbackContext, $pvContext);
# pfImportCallback : PFE_IMPORT_FUNC -> LPVOID
# pvCallbackContext : void* optional -> LPVOID
# pvContext : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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