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

OpenEncryptedFileRawA

関数
暗号化ファイルのバックアップ復元用にRAW操作を開始する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD OpenEncryptedFileRawA(
    LPCSTR lpFileName,
    DWORD ulFlags,
    void** pvContext
);

パラメーター

名前方向説明
lpFileNameLPCSTRin開くファイルの名前。文字列は Windows 文字セットの文字で構成されている必要があります。
ulFlagsDWORDin

実行する操作。このパラメーターには次のいずれかの値を指定できます。

意味
0
ファイルをエクスポート(バックアップ)用に開きます。
CREATE_FOR_IMPORT
1
ファイルをインポート(リストア)用に開きます。
CREATE_FOR_DIR
2
暗号化されたファイルを含むディレクトリをインポート(リストア)します。操作を示すために、前述の 2 つのフラグのいずれかと組み合わせる必要があります。
OVERWRITE_HIDDEN
4
インポート時に隠しファイルを上書きします。
pvContextvoid**out後続の ReadEncryptedFileRawWriteEncryptedFileRaw、または CloseEncryptedFileRaw の呼び出しで提示する必要があるコンテキストブロックのアドレス。これを変更しないでください。

戻り値の型: DWORD

公式ドキュメント

暗号化されたファイルを、バックアップ(エクスポート)またはリストア(インポート)するために開きます。(ANSI)

戻り値

関数が成功した場合は ERROR_SUCCESS を返します。

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

解説(Remarks)

呼び出しが成功するには、呼び出し元がファイルに対する読み取りまたは書き込みアクセス権を持っているか、ファイルが存在するマシンでバックアップ特権 SeBackupPrivilege を持っている必要があります。

暗号化されたファイルをバックアップするには、OpenEncryptedFileRaw を呼び出してファイルを開き、次に ReadEncryptedFileRaw を呼び出します。バックアップが完了したら、CloseEncryptedFileRaw を呼び出します。

暗号化されたファイルをリストアするには、ulFlags パラメーターに CREATE_FOR_IMPORT を指定して OpenEncryptedFileRaw を呼び出し、次に WriteEncryptedFileRaw を 1 回呼び出します。操作が完了したら、CloseEncryptedFileRaw を呼び出します。

リモートマシン上の暗号化されたファイルを開く際に lpFileNameMAX_PATH 文字を超える場合、OpenEncryptedFileRaw は失敗します。

呼び出し元がファイルのキーにアクセスできない場合、暗号化されたファイルをエクスポートするには SeBackupPrivilege が、暗号化されたファイルをインポートするには SeRestorePrivilege が必要です。

BackupRead 関数と BackupWrite 関数は、暗号化されていないファイルのバックアップとリストアを処理します。

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 バージョンを自動的に選択するエイリアスとして OpenEncryptedFileRaw を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないコードではないものと混在させると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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>

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

OpenEncryptedFileRawA = ctypes.windll.advapi32.OpenEncryptedFileRawA
OpenEncryptedFileRawA.restype = wintypes.DWORD
OpenEncryptedFileRawA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.DWORD,  # ulFlags : DWORD
    ctypes.c_void_p,  # pvContext : void** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procOpenEncryptedFileRawA = advapi32.NewProc("OpenEncryptedFileRawA")
)

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

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

typedef OpenEncryptedFileRawANative = Uint32 Function(Pointer<Utf8>, Uint32, Pointer<Void>);
typedef OpenEncryptedFileRawADart = int Function(Pointer<Utf8>, int, Pointer<Void>);
final OpenEncryptedFileRawA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<OpenEncryptedFileRawANative, OpenEncryptedFileRawADart>('OpenEncryptedFileRawA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// ulFlags : DWORD -> Uint32
// pvContext : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenEncryptedFileRawA(
  lpFileName: PAnsiChar;   // LPCSTR
  ulFlags: DWORD;   // DWORD
  pvContext: Pointer   // void** out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'OpenEncryptedFileRawA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenEncryptedFileRawA"
  c_OpenEncryptedFileRawA :: CString -> Word32 -> Ptr () -> IO Word32
-- lpFileName : LPCSTR -> CString
-- ulFlags : DWORD -> Word32
-- pvContext : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openencryptedfilerawa =
  foreign "OpenEncryptedFileRawA"
    (string @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* lpFileName : LPCSTR -> string *)
(* ulFlags : DWORD -> uint32_t *)
(* pvContext : void** 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 ("OpenEncryptedFileRawA" open-encrypted-file-raw-a :convention :stdcall) :uint32
  (lp-file-name :string)   ; LPCSTR
  (ul-flags :uint32)   ; DWORD
  (pv-context :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenEncryptedFileRawA = Win32::API::More->new('ADVAPI32',
    'DWORD OpenEncryptedFileRawA(LPCSTR lpFileName, DWORD ulFlags, LPVOID pvContext)');
# my $ret = $OpenEncryptedFileRawA->Call($lpFileName, $ulFlags, $pvContext);
# lpFileName : LPCSTR -> LPCSTR
# ulFlags : DWORD -> DWORD
# pvContext : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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