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

OpenFileById

関数
ファイルIDを指定してファイルを開く。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HANDLE OpenFileById(
    HANDLE hVolumeHint,
    FILE_ID_DESCRIPTOR* lpFileId,
    DWORD dwDesiredAccess,
    FILE_SHARE_MODE dwShareMode,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    FILE_FLAGS_AND_ATTRIBUTES dwFlagsAndAttributes
);

パラメーター

名前方向説明
hVolumeHintHANDLEin開くファイルが格納されているボリュームまたは共有上の、任意のファイルへのハンドル。
lpFileIdFILE_ID_DESCRIPTOR*in開くファイルを識別する FILE_ID_DESCRIPTOR へのポインター。
dwDesiredAccessDWORDin

オブジェクトへのアクセス。アクセスには読み取り、書き込み、またはその両方を指定できます。

詳細については、 File Security and Access Rights を参照してください。開いているハンドルを持つオープン要求で指定された共有モードと競合するアクセスモードを要求することはできません。

このパラメーターが 0 の場合、アプリケーションはデバイスにアクセスせずにファイルおよびデバイスの属性を照会できます。これは、ドライブにフロッピーを入れることなくフロッピーディスクドライブのサイズやサポートされるフォーマットを判別する場合に便利です。また、読み取りまたは書き込みアクセスで開くことなく、ファイルまたはディレクトリの存在をテストするためにも使用できます。

dwShareModeFILE_SHARE_MODEin

オブジェクトの共有モード。読み取り、書き込み、その両方、またはなしを指定できます。

開いているハンドルを持つオープン要求で指定されたアクセスモードと競合する共有モードを要求することはできません。そのようにすると、次の共有違反が発生します: (ERROR_SHARING_VIOLATION)。詳細については、 Creating and Opening Files を参照してください。

このパラメーターが 0 で、かつ OpenFileById が成功した場合、オブジェクトは共有できず、ハンドルが閉じられるまで再度開くことはできません。詳細については、このトピックの「解説」セクションを参照してください。

共有オプションは、オブジェクトへのハンドルを閉じるまで有効です。

別のプロセスがオブジェクトを開いている間にプロセスがそのオブジェクトを共有できるようにするには、次の値を 1 つ以上組み合わせて、オブジェクトを開く際に要求できるアクセスモードを指定します。

Value Meaning
FILE_SHARE_DELETE
0x00000004
オブジェクトに対する後続のオープン操作で、削除アクセスを要求できるようにします。

それ以外の場合、削除アクセスを要求する他のプロセスはオブジェクトを開けません。

このフラグが指定されていないが、オブジェクトが削除アクセスで開かれている場合、関数は失敗します。

FILE_SHARE_READ
0x00000001
オブジェクトに対する後続のオープン操作で、読み取りアクセスを要求できるようにします。

それ以外の場合、読み取りアクセスを要求する他のプロセスはオブジェクトを開けません。

このフラグが指定されていないが、オブジェクトが読み取りアクセスで開かれている場合、関数は失敗します。

FILE_SHARE_WRITE
0x00000002
オブジェクトに対する後続のオープン操作で、書き込みアクセスを要求できるようにします。

それ以外の場合、書き込みアクセスを要求する他のプロセスはオブジェクトを開けません。

このフラグが指定されていないが、オブジェクトが書き込みアクセスで開かれている、または書き込みアクセスを持つファイルマッピングがある場合、関数は失敗します。

lpSecurityAttributesSECURITY_ATTRIBUTES*inoptional予約済み。
dwFlagsAndAttributesFILE_FLAGS_AND_ATTRIBUTESin

ファイルフラグ。

OpenFileById はファイルを開く際、ファイルフラグを既存のファイル属性と組み合わせ、指定されたファイル属性は無視します。このパラメーターには、次のフラグの任意の組み合わせを含めることができます。

Value Meaning
FILE_FLAG_BACKUP_SEMANTICS
0x02000000
バックアップまたは復元操作のためにファイルを開きます。プロセスが SE_BACKUP_NAME および SE_RESTORE_NAME 特権を持つ場合、システムは呼び出し元プロセスがファイルセキュリティチェックをオーバーライドすることを保証します。詳細については、 Changing Privileges in a Token を参照してください。

ディレクトリへのハンドルを取得するには、このフラグを設定する必要があります。ディレクトリハンドルは、ファイルハンドルの代わりに一部の関数に渡すことができます。詳細については、 Directory Handles を参照してください。

FILE_FLAG_NO_BUFFERING
0x20000000
システムキャッシュを使用せずにファイルを開きます。このフラグはハードディスクのキャッシュには影響しません。FILE_FLAG_OVERLAPPED と組み合わせると、I/O がメモリマネージャーの同期操作に依存しないため、最大の非同期パフォーマンスが得られます。ただし、データがキャッシュに保持されないため、一部の I/O 操作はより時間がかかります。また、ファイルメタデータは依然としてキャッシュされる場合があります。メタデータをディスクにフラッシュするには、FlushFileBuffers 関数を使用します。

FILE_FLAG_NO_BUFFERING で開かれたファイルを扱う際、アプリケーションは特定の要件を満たす必要があります:

  • ファイルアクセスは、ボリュームセクターサイズの整数倍であるファイル内のバイトオフセットから開始する必要があります。
  • ファイルアクセスは、ボリュームセクターサイズの整数倍であるバイト数で行う必要があります。たとえば、セクターサイズが 512 バイトの場合、アプリケーションは 512、1024、1536、2048 バイトの読み取りおよび書き込みを要求できますが、335、981、7171 バイトは要求できません。
  • 読み取りおよび書き込み操作のバッファーアドレスはセクターアラインされている必要があります。つまり、ボリュームセクターサイズの整数倍であるメモリ上のアドレスにアラインされている必要があります。ディスクによっては、この要件が強制されない場合があります。
バッファーをボリュームセクターサイズの整数倍にアラインする 1 つの方法は、VirtualAlloc を使用してバッファーを割り当てることです。これは、オペレーティングシステムのメモリページサイズの整数倍であるアドレスにアラインされたメモリを割り当てます。メモリページとボリュームセクターのサイズはどちらも 2 のべき乗であるため、このメモリはボリュームセクターサイズの整数倍であるアドレスにもアラインされます。メモリページは 4~8 KB のサイズで、セクターは 512 バイト(ハードディスク)または 2048 バイト(CD)です。したがって、ボリュームセクターがメモリページより大きくなることはありません。

アプリケーションは、GetDiskFreeSpace 関数を呼び出すことでボリュームセクターサイズを判別できます。

FILE_FLAG_OPEN_NO_RECALL
0x00100000
ファイルデータが要求されますが、リモートストレージに留まったままになります。ローカルストレージへ戻されることはありません。このフラグはリモートストレージシステムで使用するためのものです。
FILE_FLAG_OPEN_REPARSE_POINT
0x00200000
このフラグを使用すると、通常の reparse point 処理は行われず、OpenFileById は再解析ポイントを開こうとします。ファイルが開かれると、再解析ポイントを制御するフィルターが動作しているかどうかにかかわらず、ファイルハンドルが返されます。このフラグは CREATE_ALWAYS フラグと併用できません。ファイルが再解析ポイントでない場合、このフラグは無視されます。
FILE_FLAG_OVERLAPPED
0x40000000
非同期 I/O のためにファイルを開く、または作成します。操作が完了すると、OVERLAPPED 構造体で呼び出しに指定されたイベントがシグナル状態に設定されます。処理にかなりの時間を要する操作は ERROR_IO_PENDING を返します。

このフラグが指定されている場合、ファイルは同時の読み取りおよび書き込み操作に使用できます。システムはファイルポインターを保持しないため、OVERLAPPED 構造体内でファイル位置を読み取りおよび書き込み関数に渡すか、ファイルポインターを更新する必要があります。

このフラグが指定されていない場合、読み取りおよび書き込み関数の呼び出しで OVERLAPPED 構造体を指定したとしても、I/O 操作はシリアル化されます。

FILE_FLAG_RANDOM_ACCESS
0x10000000
ファイルにランダムにアクセスします。システムはこれをファイルキャッシュを最適化するためのヒントとして使用できます。
FILE_FLAG_SEQUENTIAL_SCAN
0x08000000
ファイルに先頭から末尾まで順次アクセスします。システムはこれをファイルキャッシュを最適化するためのヒントとして使用できます。アプリケーションがランダムアクセスのためにファイルポインターを移動した場合、最適なキャッシュが行われない可能性があります。ただし、正しい動作は依然として保証されます。

このフラグを指定すると、順次アクセスで大きなファイルを読み取るアプリケーションのパフォーマンスを向上させることができます。大きなファイルを主に順次読み取るが、ときどき小さなバイト範囲をスキップするアプリケーションでは、パフォーマンスの向上がさらに顕著になることがあります。

FILE_FLAG_WRITE_THROUGH
0x80000000
システムは中間キャッシュを介さずに書き込みを行い、直接ディスクへ書き込みます。

FILE_FLAG_NO_BUFFERING が併せて指定されておらず、システムキャッシュが有効な場合、データはシステムキャッシュに書き込まれますが、遅延なくディスクにフラッシュされます。

FILE_FLAG_NO_BUFFERING も指定されており、システムキャッシュが有効でない場合、データはシステムキャッシュを経由せずに直ちにディスクへフラッシュされます。オペレーティングシステムは、ハードディスクキャッシュを介した永続メディアへのライトスルーも要求します。ただし、すべてのハードウェアがこのライトスルー機能をサポートしているわけではありません。

戻り値の型: HANDLE

公式ドキュメント

指定された識別子に一致するファイルを開きます。

戻り値

関数が成功した場合、戻り値は指定されたファイルへのオープンハンドルです。

関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

OpenFileById が返すオブジェクトハンドルを閉じるには、CloseHandle 関数を使用します。

以前の DeleteFile の呼び出しによって削除待ちの状態にあるファイルに対して OpenFileById を呼び出すと、関数は失敗します。オペレーティングシステムは、ファイルへのすべてのハンドルが閉じられるまでファイルの削除を遅延させます。GetLastErrorERROR_ACCESS_DENIED を返します。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされます。

Technology Supported
Server Message Block (SMB) 3.0 protocol No
SMB 3.0 Transparent Failover (TFO) No
SMB 3.0 with Scale-out File Shares (SO) No
Cluster Shared Volume File System (CsvFS) Yes
Resilient File System (ReFS) Yes
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HANDLE OpenFileById(
    HANDLE hVolumeHint,
    FILE_ID_DESCRIPTOR* lpFileId,
    DWORD dwDesiredAccess,
    FILE_SHARE_MODE dwShareMode,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    FILE_FLAGS_AND_ATTRIBUTES dwFlagsAndAttributes
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenFileById(
    IntPtr hVolumeHint,   // HANDLE
    IntPtr lpFileId,   // FILE_ID_DESCRIPTOR*
    uint dwDesiredAccess,   // DWORD
    uint dwShareMode,   // FILE_SHARE_MODE
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    uint dwFlagsAndAttributes   // FILE_FLAGS_AND_ATTRIBUTES
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenFileById(
    hVolumeHint As IntPtr,   ' HANDLE
    lpFileId As IntPtr,   ' FILE_ID_DESCRIPTOR*
    dwDesiredAccess As UInteger,   ' DWORD
    dwShareMode As UInteger,   ' FILE_SHARE_MODE
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    dwFlagsAndAttributes As UInteger   ' FILE_FLAGS_AND_ATTRIBUTES
) As IntPtr
End Function
' hVolumeHint : HANDLE
' lpFileId : FILE_ID_DESCRIPTOR*
' dwDesiredAccess : DWORD
' dwShareMode : FILE_SHARE_MODE
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES
Declare PtrSafe Function OpenFileById Lib "kernel32" ( _
    ByVal hVolumeHint As LongPtr, _
    ByVal lpFileId As LongPtr, _
    ByVal dwDesiredAccess As Long, _
    ByVal dwShareMode As Long, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal dwFlagsAndAttributes As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenFileById = ctypes.windll.kernel32.OpenFileById
OpenFileById.restype = ctypes.c_void_p
OpenFileById.argtypes = [
    wintypes.HANDLE,  # hVolumeHint : HANDLE
    ctypes.c_void_p,  # lpFileId : FILE_ID_DESCRIPTOR*
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.DWORD,  # dwShareMode : FILE_SHARE_MODE
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.DWORD,  # dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenFileById = Fiddle::Function.new(
  lib['OpenFileById'],
  [
    Fiddle::TYPE_VOIDP,  # hVolumeHint : HANDLE
    Fiddle::TYPE_VOIDP,  # lpFileId : FILE_ID_DESCRIPTOR*
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    -Fiddle::TYPE_INT,  # dwShareMode : FILE_SHARE_MODE
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    -Fiddle::TYPE_INT,  # dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn OpenFileById(
        hVolumeHint: *mut core::ffi::c_void,  // HANDLE
        lpFileId: *mut FILE_ID_DESCRIPTOR,  // FILE_ID_DESCRIPTOR*
        dwDesiredAccess: u32,  // DWORD
        dwShareMode: u32,  // FILE_SHARE_MODE
        lpSecurityAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        dwFlagsAndAttributes: u32  // FILE_FLAGS_AND_ATTRIBUTES
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr OpenFileById(IntPtr hVolumeHint, IntPtr lpFileId, uint dwDesiredAccess, uint dwShareMode, IntPtr lpSecurityAttributes, uint dwFlagsAndAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenFileById' -Namespace Win32 -PassThru
# $api::OpenFileById(hVolumeHint, lpFileId, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlagsAndAttributes)
#uselib "KERNEL32.dll"
#func global OpenFileById "OpenFileById" sptr, sptr, sptr, sptr, sptr, sptr
; OpenFileById hVolumeHint, varptr(lpFileId), dwDesiredAccess, dwShareMode, varptr(lpSecurityAttributes), dwFlagsAndAttributes   ; 戻り値は stat
; hVolumeHint : HANDLE -> "sptr"
; lpFileId : FILE_ID_DESCRIPTOR* -> "sptr"
; dwDesiredAccess : DWORD -> "sptr"
; dwShareMode : FILE_SHARE_MODE -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global OpenFileById "OpenFileById" sptr, var, int, int, var, int
; res = OpenFileById(hVolumeHint, lpFileId, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlagsAndAttributes)
; hVolumeHint : HANDLE -> "sptr"
; lpFileId : FILE_ID_DESCRIPTOR* -> "var"
; dwDesiredAccess : DWORD -> "int"
; dwShareMode : FILE_SHARE_MODE -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE OpenFileById(HANDLE hVolumeHint, FILE_ID_DESCRIPTOR* lpFileId, DWORD dwDesiredAccess, FILE_SHARE_MODE dwShareMode, SECURITY_ATTRIBUTES* lpSecurityAttributes, FILE_FLAGS_AND_ATTRIBUTES dwFlagsAndAttributes)
#uselib "KERNEL32.dll"
#cfunc global OpenFileById "OpenFileById" intptr, var, int, int, var, int
; res = OpenFileById(hVolumeHint, lpFileId, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlagsAndAttributes)
; hVolumeHint : HANDLE -> "intptr"
; lpFileId : FILE_ID_DESCRIPTOR* -> "var"
; dwDesiredAccess : DWORD -> "int"
; dwShareMode : FILE_SHARE_MODE -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenFileById = kernel32.NewProc("OpenFileById")
)

// hVolumeHint (HANDLE), lpFileId (FILE_ID_DESCRIPTOR*), dwDesiredAccess (DWORD), dwShareMode (FILE_SHARE_MODE), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional), dwFlagsAndAttributes (FILE_FLAGS_AND_ATTRIBUTES)
r1, _, err := procOpenFileById.Call(
	uintptr(hVolumeHint),
	uintptr(lpFileId),
	uintptr(dwDesiredAccess),
	uintptr(dwShareMode),
	uintptr(lpSecurityAttributes),
	uintptr(dwFlagsAndAttributes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenFileById(
  hVolumeHint: THandle;   // HANDLE
  lpFileId: Pointer;   // FILE_ID_DESCRIPTOR*
  dwDesiredAccess: DWORD;   // DWORD
  dwShareMode: DWORD;   // FILE_SHARE_MODE
  lpSecurityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  dwFlagsAndAttributes: DWORD   // FILE_FLAGS_AND_ATTRIBUTES
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenFileById';
result := DllCall("KERNEL32\OpenFileById"
    , "Ptr", hVolumeHint   ; HANDLE
    , "Ptr", lpFileId   ; FILE_ID_DESCRIPTOR*
    , "UInt", dwDesiredAccess   ; DWORD
    , "UInt", dwShareMode   ; FILE_SHARE_MODE
    , "Ptr", lpSecurityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "UInt", dwFlagsAndAttributes   ; FILE_FLAGS_AND_ATTRIBUTES
    , "Ptr")   ; return: HANDLE
●OpenFileById(hVolumeHint, lpFileId, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlagsAndAttributes) = DLL("KERNEL32.dll", "void* OpenFileById(void*, void*, dword, dword, void*, dword)")
# 呼び出し: OpenFileById(hVolumeHint, lpFileId, dwDesiredAccess, dwShareMode, lpSecurityAttributes, dwFlagsAndAttributes)
# hVolumeHint : HANDLE -> "void*"
# lpFileId : FILE_ID_DESCRIPTOR* -> "void*"
# dwDesiredAccess : DWORD -> "dword"
# dwShareMode : FILE_SHARE_MODE -> "dword"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OpenFileByIdNative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32, Pointer<Void>, Uint32);
typedef OpenFileByIdDart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, int, int, Pointer<Void>, int);
final OpenFileById = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<OpenFileByIdNative, OpenFileByIdDart>('OpenFileById');
// hVolumeHint : HANDLE -> Pointer<Void>
// lpFileId : FILE_ID_DESCRIPTOR* -> Pointer<Void>
// dwDesiredAccess : DWORD -> Uint32
// dwShareMode : FILE_SHARE_MODE -> Uint32
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenFileById(
  hVolumeHint: THandle;   // HANDLE
  lpFileId: Pointer;   // FILE_ID_DESCRIPTOR*
  dwDesiredAccess: DWORD;   // DWORD
  dwShareMode: DWORD;   // FILE_SHARE_MODE
  lpSecurityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  dwFlagsAndAttributes: DWORD   // FILE_FLAGS_AND_ATTRIBUTES
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenFileById';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenFileById"
  c_OpenFileById :: Ptr () -> Ptr () -> Word32 -> Word32 -> Ptr () -> Word32 -> IO (Ptr ())
-- hVolumeHint : HANDLE -> Ptr ()
-- lpFileId : FILE_ID_DESCRIPTOR* -> Ptr ()
-- dwDesiredAccess : DWORD -> Word32
-- dwShareMode : FILE_SHARE_MODE -> Word32
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openfilebyid =
  foreign "OpenFileById"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning (ptr void))
(* hVolumeHint : HANDLE -> (ptr void) *)
(* lpFileId : FILE_ID_DESCRIPTOR* -> (ptr void) *)
(* dwDesiredAccess : DWORD -> uint32_t *)
(* dwShareMode : FILE_SHARE_MODE -> uint32_t *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("OpenFileById" open-file-by-id :convention :stdcall) :pointer
  (h-volume-hint :pointer)   ; HANDLE
  (lp-file-id :pointer)   ; FILE_ID_DESCRIPTOR*
  (dw-desired-access :uint32)   ; DWORD
  (dw-share-mode :uint32)   ; FILE_SHARE_MODE
  (lp-security-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (dw-flags-and-attributes :uint32))   ; FILE_FLAGS_AND_ATTRIBUTES
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenFileById = Win32::API::More->new('KERNEL32',
    'HANDLE OpenFileById(HANDLE hVolumeHint, LPVOID lpFileId, DWORD dwDesiredAccess, DWORD dwShareMode, LPVOID lpSecurityAttributes, DWORD dwFlagsAndAttributes)');
# my $ret = $OpenFileById->Call($hVolumeHint, $lpFileId, $dwDesiredAccess, $dwShareMode, $lpSecurityAttributes, $dwFlagsAndAttributes);
# hVolumeHint : HANDLE -> HANDLE
# lpFileId : FILE_ID_DESCRIPTOR* -> LPVOID
# dwDesiredAccess : DWORD -> DWORD
# dwShareMode : FILE_SHARE_MODE -> DWORD
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# dwFlagsAndAttributes : FILE_FLAGS_AND_ATTRIBUTES -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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