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

AddUsersToEncryptedFile

関数
暗号化ファイルに証明書でユーザーのアクセス権を追加する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD AddUsersToEncryptedFile(
    LPCWSTR lpFileName,
    ENCRYPTION_CERTIFICATE_LIST* pEncryptionCertificates
);

パラメーター

名前方向説明
lpFileNameLPCWSTRin暗号化ファイルの名前。
pEncryptionCertificatesENCRYPTION_CERTIFICATE_LIST*inファイルに追加する新しいユーザーキーのリストを格納した ENCRYPTION_CERTIFICATE_LIST 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

指定された暗号化ファイルにユーザーキーを追加します。

戻り値

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

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

解説(Remarks)

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

この関数を使用するサンプルコードについては、Adding Users to an Encrypted File を参照してください。

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

各言語での呼び出し定義

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

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

AddUsersToEncryptedFile = ctypes.windll.advapi32.AddUsersToEncryptedFile
AddUsersToEncryptedFile.restype = wintypes.DWORD
AddUsersToEncryptedFile.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.c_void_p,  # pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
AddUsersToEncryptedFile = Fiddle::Function.new(
  lib['AddUsersToEncryptedFile'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn AddUsersToEncryptedFile(
        lpFileName: *const u16,  // LPCWSTR
        pEncryptionCertificates: *mut ENCRYPTION_CERTIFICATE_LIST  // ENCRYPTION_CERTIFICATE_LIST*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint AddUsersToEncryptedFile([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, IntPtr pEncryptionCertificates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_AddUsersToEncryptedFile' -Namespace Win32 -PassThru
# $api::AddUsersToEncryptedFile(lpFileName, pEncryptionCertificates)
#uselib "ADVAPI32.dll"
#func global AddUsersToEncryptedFile "AddUsersToEncryptedFile" sptr, sptr
; AddUsersToEncryptedFile lpFileName, varptr(pEncryptionCertificates)   ; 戻り値は stat
; lpFileName : LPCWSTR -> "sptr"
; pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global AddUsersToEncryptedFile "AddUsersToEncryptedFile" wstr, var
; res = AddUsersToEncryptedFile(lpFileName, pEncryptionCertificates)
; lpFileName : LPCWSTR -> "wstr"
; pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD AddUsersToEncryptedFile(LPCWSTR lpFileName, ENCRYPTION_CERTIFICATE_LIST* pEncryptionCertificates)
#uselib "ADVAPI32.dll"
#cfunc global AddUsersToEncryptedFile "AddUsersToEncryptedFile" wstr, var
; res = AddUsersToEncryptedFile(lpFileName, pEncryptionCertificates)
; lpFileName : LPCWSTR -> "wstr"
; pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procAddUsersToEncryptedFile = advapi32.NewProc("AddUsersToEncryptedFile")
)

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

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

typedef AddUsersToEncryptedFileNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>);
typedef AddUsersToEncryptedFileDart = int Function(Pointer<Utf16>, Pointer<Void>);
final AddUsersToEncryptedFile = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<AddUsersToEncryptedFileNative, AddUsersToEncryptedFileDart>('AddUsersToEncryptedFile');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AddUsersToEncryptedFile(
  lpFileName: PWideChar;   // LPCWSTR
  pEncryptionCertificates: Pointer   // ENCRYPTION_CERTIFICATE_LIST*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'AddUsersToEncryptedFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AddUsersToEncryptedFile"
  c_AddUsersToEncryptedFile :: CWString -> Ptr () -> IO Word32
-- lpFileName : LPCWSTR -> CWString
-- pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let adduserstoencryptedfile =
  foreign "AddUsersToEncryptedFile"
    ((ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("AddUsersToEncryptedFile" add-users-to-encrypted-file :convention :stdcall) :uint32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-encryption-certificates :pointer))   ; ENCRYPTION_CERTIFICATE_LIST*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AddUsersToEncryptedFile = Win32::API::More->new('ADVAPI32',
    'DWORD AddUsersToEncryptedFile(LPCWSTR lpFileName, LPVOID pEncryptionCertificates)');
# my $ret = $AddUsersToEncryptedFile->Call($lpFileName, $pEncryptionCertificates);
# lpFileName : LPCWSTR -> LPCWSTR
# pEncryptionCertificates : ENCRYPTION_CERTIFICATE_LIST* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型