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

QueryUsersOnEncryptedFile

関数
暗号化ファイルにアクセス可能なユーザー一覧を取得する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD QueryUsersOnEncryptedFile(
    LPCWSTR lpFileName,
    ENCRYPTION_CERTIFICATE_HASH_LIST** pUsers
);

パラメーター

名前方向説明
lpFileNameLPCWSTRinファイルの名前。
pUsersENCRYPTION_CERTIFICATE_HASH_LIST**outユーザーの一覧を受け取る ENCRYPTION_CERTIFICATE_HASH_LIST 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

指定したファイルのユーザーの一覧を取得します。

戻り値

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

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

解説(Remarks)

ユーザーの一覧が不要になったら、 FreeEncryptionCertificateHashList 関数を呼び出して一覧を解放します。

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

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

各言語での呼び出し定義

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

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

QueryUsersOnEncryptedFile = ctypes.windll.advapi32.QueryUsersOnEncryptedFile
QueryUsersOnEncryptedFile.restype = wintypes.DWORD
QueryUsersOnEncryptedFile.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.c_void_p,  # pUsers : ENCRYPTION_CERTIFICATE_HASH_LIST** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procQueryUsersOnEncryptedFile = advapi32.NewProc("QueryUsersOnEncryptedFile")
)

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

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

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

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

let queryusersonencryptedfile =
  foreign "QueryUsersOnEncryptedFile"
    ((ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* pUsers : ENCRYPTION_CERTIFICATE_HASH_LIST** 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 ("QueryUsersOnEncryptedFile" query-users-on-encrypted-file :convention :stdcall) :uint32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-users :pointer))   ; ENCRYPTION_CERTIFICATE_HASH_LIST** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueryUsersOnEncryptedFile = Win32::API::More->new('ADVAPI32',
    'DWORD QueryUsersOnEncryptedFile(LPCWSTR lpFileName, LPVOID pUsers)');
# my $ret = $QueryUsersOnEncryptedFile->Call($lpFileName, $pUsers);
# lpFileName : LPCWSTR -> LPCWSTR
# pUsers : ENCRYPTION_CERTIFICATE_HASH_LIST** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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