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

SetUserFileEncryptionKeyEx

関数
機能や属性を指定してファイル暗号化のユーザー鍵を設定する。
DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

DWORD SetUserFileEncryptionKeyEx(
    ENCRYPTION_CERTIFICATE* pEncryptionCertificate,   // optional
    DWORD dwCapabilities,
    DWORD dwFlags,
    void* pvReserved   // optional
);

パラメーター

名前型方向説明
pEncryptionCertificateENCRYPTION_CERTIFICATE*inoptional現在のユーザーに設定する暗号化証明書を指す構造体ポインタ。NULL可。
dwCapabilitiesDWORDin証明書の機能を示すフラグ。CNGアルゴリズム対応等を指定する。
dwFlagsDWORDin動作を制御するフラグ。証明書の選択挙動等を指定する。
pvReservedvoid*optional予約済みパラメータ。NULLを指定する必要がある。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD SetUserFileEncryptionKeyEx(
    ENCRYPTION_CERTIFICATE* pEncryptionCertificate,   // optional
    DWORD dwCapabilities,
    DWORD dwFlags,
    void* pvReserved   // optional
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint SetUserFileEncryptionKeyEx(
    IntPtr pEncryptionCertificate,   // ENCRYPTION_CERTIFICATE* optional
    uint dwCapabilities,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr pvReserved   // void* optional
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function SetUserFileEncryptionKeyEx(
    pEncryptionCertificate As IntPtr,   ' ENCRYPTION_CERTIFICATE* optional
    dwCapabilities As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    pvReserved As IntPtr   ' void* optional
) As UInteger
End Function
' pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional
' dwCapabilities : DWORD
' dwFlags : DWORD
' pvReserved : void* optional
Declare PtrSafe Function SetUserFileEncryptionKeyEx Lib "advapi32" ( _
    ByVal pEncryptionCertificate As LongPtr, _
    ByVal dwCapabilities As Long, _
    ByVal dwFlags As Long, _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetUserFileEncryptionKeyEx = ctypes.windll.advapi32.SetUserFileEncryptionKeyEx
SetUserFileEncryptionKeyEx.restype = wintypes.DWORD
SetUserFileEncryptionKeyEx.argtypes = [
    ctypes.c_void_p,  # pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional
    wintypes.DWORD,  # dwCapabilities : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pvReserved : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procSetUserFileEncryptionKeyEx = advapi32.NewProc("SetUserFileEncryptionKeyEx")
)

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

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

typedef SetUserFileEncryptionKeyExNative = Uint32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef SetUserFileEncryptionKeyExDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final SetUserFileEncryptionKeyEx = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<SetUserFileEncryptionKeyExNative, SetUserFileEncryptionKeyExDart>('SetUserFileEncryptionKeyEx');
// pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional -> Pointer<Void>
// dwCapabilities : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// pvReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetUserFileEncryptionKeyEx(
  pEncryptionCertificate: Pointer;   // ENCRYPTION_CERTIFICATE* optional
  dwCapabilities: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pvReserved: Pointer   // void* optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'SetUserFileEncryptionKeyEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetUserFileEncryptionKeyEx"
  c_SetUserFileEncryptionKeyEx :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO Word32
-- pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional -> Ptr ()
-- dwCapabilities : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- pvReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setuserfileencryptionkeyex =
  foreign "SetUserFileEncryptionKeyEx"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional -> (ptr void) *)
(* dwCapabilities : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pvReserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("SetUserFileEncryptionKeyEx" set-user-file-encryption-key-ex :convention :stdcall) :uint32
  (p-encryption-certificate :pointer)   ; ENCRYPTION_CERTIFICATE* optional
  (dw-capabilities :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD
  (pv-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetUserFileEncryptionKeyEx = Win32::API::More->new('ADVAPI32',
    'DWORD SetUserFileEncryptionKeyEx(LPVOID pEncryptionCertificate, DWORD dwCapabilities, DWORD dwFlags, LPVOID pvReserved)');
# my $ret = $SetUserFileEncryptionKeyEx->Call($pEncryptionCertificate, $dwCapabilities, $dwFlags, $pvReserved);
# pEncryptionCertificate : ENCRYPTION_CERTIFICATE* optional -> LPVOID
# dwCapabilities : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# pvReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型