ホーム › Storage.FileSystem › DuplicateEncryptionInfoFile

DuplicateEncryptionInfoFile

関数

暗号化情報を引き継いでファイルを複製する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD DuplicateEncryptionInfoFile(
    LPCWSTR SrcFileName,
    LPCWSTR DstFileName,
    DWORD dwCreationDistribution,
    DWORD dwAttributes,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前

型

方向

説明

SrcFileName

LPCWSTR

EFS メタデータのコピー元となるファイルまたはディレクトリの名前です。このコピー元のファイルまたはディレクトリは暗号化されている必要があります。

DstFileName

LPCWSTR

EFS メタデータのコピー先となるファイルまたはディレクトリの名前です。

このコピー先のファイルまたはディレクトリは、この関数を呼び出す前に暗号化されている必要はありません。ただし、この関数が正常に完了すると暗号化されます。

SrcFileName の値がファイルを指定している場合、このパラメーターの値もファイルを指定する必要があります。ディレクトリの場合も同様です。このパラメーターで指定された名前のファイルまたはディレクトリが存在しない場合、(SrcFileName がファイルとディレクトリのどちらを指定しているかに応じて) ファイルまたはディレクトリが作成されます。

dwCreationDistribution

DWORD

DstFileName パラメーターの値で識別されるコピー先のファイルまたはディレクトリを、どのように開くかを記述します。このパラメーターの有効な値は次のとおりです。

値	意味
CREATE_ALWAYS 2	コピー先のファイルまたはディレクトリを常に作成します。このパラメーターに CREATE_NEW 以外の値が渡された場合は、CREATE_ALWAYS として処理されます。
CREATE_NEW 1	コピー先のファイルまたはディレクトリが既に存在しない場合にのみ作成します。既に存在し、かつこの値が指定された場合、この関数は失敗します。

dwAttributes

DWORD

コピー先のファイルまたはディレクトリのファイル属性です。FILE_READ_ONLY 属性は、現在この関数では処理されません。

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

コピー先のファイルまたはディレクトリがまだ存在しない場合に、そのセキュリティ属性を指定する SECURITY_ATTRIBUTES 構造体へのポインターです。NULL を指定した場合、ファイルまたはディレクトリには既定のセキュリティ記述子が設定されます。ファイルまたはディレクトリの既定のセキュリティ記述子内の ACL は、その親ディレクトリから継承されます。

戻り値の型: DWORD

公式ドキュメント

EFS メタデータをあるファイルまたはディレクトリから別のファイルまたはディレクトリへコピーします。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの完全な一覧については、 System Error Codes またはヘッダーファイル WinError.h を参照してください。

解説(Remarks)

この関数の呼び出しでは、EFS によってコピー先のファイルまたはディレクトリへの排他アクセスが必要とされます。このアクセスが提供されない場合、この関数は失敗します。

呼び出し元は、コピー元のファイルまたはディレクトリの EFS キーを持っており、少なくともコピー元のファイルまたはディレクトリに対する READ_ATTRIBUTE ACL を持っている必要があります。

指定されたコピー元およびコピー先のファイルまたはディレクトリは、同じコンピューター上に存在する必要があります。そうでない場合、エラーが返されます。

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 をサポートしません。

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

各言語での呼び出し定義

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

DWORD DuplicateEncryptionInfoFile(
    LPCWSTR SrcFileName,
    LPCWSTR DstFileName,
    DWORD dwCreationDistribution,
    DWORD dwAttributes,
    const SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint DuplicateEncryptionInfoFile(
    [MarshalAs(UnmanagedType.LPWStr)] string SrcFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string DstFileName,   // LPCWSTR
    uint dwCreationDistribution,   // DWORD
    uint dwAttributes,   // DWORD
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function DuplicateEncryptionInfoFile(
    <MarshalAs(UnmanagedType.LPWStr)> SrcFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> DstFileName As String,   ' LPCWSTR
    dwCreationDistribution As UInteger,   ' DWORD
    dwAttributes As UInteger,   ' DWORD
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As UInteger
End Function

' SrcFileName : LPCWSTR
' DstFileName : LPCWSTR
' dwCreationDistribution : DWORD
' dwAttributes : DWORD
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function DuplicateEncryptionInfoFile Lib "advapi32" ( _
    ByVal SrcFileName As LongPtr, _
    ByVal DstFileName As LongPtr, _
    ByVal dwCreationDistribution As Long, _
    ByVal dwAttributes As Long, _
    ByVal lpSecurityAttributes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DuplicateEncryptionInfoFile = ctypes.windll.advapi32.DuplicateEncryptionInfoFile
DuplicateEncryptionInfoFile.restype = wintypes.DWORD
DuplicateEncryptionInfoFile.argtypes = [
    wintypes.LPCWSTR,  # SrcFileName : LPCWSTR
    wintypes.LPCWSTR,  # DstFileName : LPCWSTR
    wintypes.DWORD,  # dwCreationDistribution : DWORD
    wintypes.DWORD,  # dwAttributes : DWORD
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
DuplicateEncryptionInfoFile = Fiddle::Function.new(
  lib['DuplicateEncryptionInfoFile'],
  [
    Fiddle::TYPE_VOIDP,  # SrcFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # DstFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwCreationDistribution : DWORD
    -Fiddle::TYPE_INT,  # dwAttributes : DWORD
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn DuplicateEncryptionInfoFile(
        SrcFileName: *const u16,  // LPCWSTR
        DstFileName: *const u16,  // LPCWSTR
        dwCreationDistribution: u32,  // DWORD
        dwAttributes: u32,  // DWORD
        lpSecurityAttributes: *const SECURITY_ATTRIBUTES  // SECURITY_ATTRIBUTES* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint DuplicateEncryptionInfoFile([MarshalAs(UnmanagedType.LPWStr)] string SrcFileName, [MarshalAs(UnmanagedType.LPWStr)] string DstFileName, uint dwCreationDistribution, uint dwAttributes, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_DuplicateEncryptionInfoFile' -Namespace Win32 -PassThru
# $api::DuplicateEncryptionInfoFile(SrcFileName, DstFileName, dwCreationDistribution, dwAttributes, lpSecurityAttributes)

#uselib "ADVAPI32.dll"
#func global DuplicateEncryptionInfoFile "DuplicateEncryptionInfoFile" sptr, sptr, sptr, sptr, sptr
; DuplicateEncryptionInfoFile SrcFileName, DstFileName, dwCreationDistribution, dwAttributes, varptr(lpSecurityAttributes)   ; 戻り値は stat
; SrcFileName : LPCWSTR -> "sptr"
; DstFileName : LPCWSTR -> "sptr"
; dwCreationDistribution : DWORD -> "sptr"
; dwAttributes : DWORD -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global DuplicateEncryptionInfoFile "DuplicateEncryptionInfoFile" wstr, wstr, int, int, var
; res = DuplicateEncryptionInfoFile(SrcFileName, DstFileName, dwCreationDistribution, dwAttributes, lpSecurityAttributes)
; SrcFileName : LPCWSTR -> "wstr"
; DstFileName : LPCWSTR -> "wstr"
; dwCreationDistribution : DWORD -> "int"
; dwAttributes : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global DuplicateEncryptionInfoFile "DuplicateEncryptionInfoFile" wstr, wstr, int, int, sptr
; res = DuplicateEncryptionInfoFile(SrcFileName, DstFileName, dwCreationDistribution, dwAttributes, varptr(lpSecurityAttributes))
; SrcFileName : LPCWSTR -> "wstr"
; DstFileName : LPCWSTR -> "wstr"
; dwCreationDistribution : DWORD -> "int"
; dwAttributes : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。