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

LockFile

関数
ファイルの指定範囲をロックして排他制御する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL LockFile(
    HANDLE hFile,
    DWORD dwFileOffsetLow,
    DWORD dwFileOffsetHigh,
    DWORD nNumberOfBytesToLockLow,
    DWORD nNumberOfBytesToLockHigh
);

パラメーター

名前方向
hFileHANDLEin
dwFileOffsetLowDWORDin
dwFileOffsetHighDWORDin
nNumberOfBytesToLockLowDWORDin
nNumberOfBytesToLockHighDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL LockFile(
    HANDLE hFile,
    DWORD dwFileOffsetLow,
    DWORD dwFileOffsetHigh,
    DWORD nNumberOfBytesToLockLow,
    DWORD nNumberOfBytesToLockHigh
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool LockFile(
    IntPtr hFile,   // HANDLE
    uint dwFileOffsetLow,   // DWORD
    uint dwFileOffsetHigh,   // DWORD
    uint nNumberOfBytesToLockLow,   // DWORD
    uint nNumberOfBytesToLockHigh   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LockFile(
    hFile As IntPtr,   ' HANDLE
    dwFileOffsetLow As UInteger,   ' DWORD
    dwFileOffsetHigh As UInteger,   ' DWORD
    nNumberOfBytesToLockLow As UInteger,   ' DWORD
    nNumberOfBytesToLockHigh As UInteger   ' DWORD
) As Boolean
End Function
' hFile : HANDLE
' dwFileOffsetLow : DWORD
' dwFileOffsetHigh : DWORD
' nNumberOfBytesToLockLow : DWORD
' nNumberOfBytesToLockHigh : DWORD
Declare PtrSafe Function LockFile Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwFileOffsetLow As Long, _
    ByVal dwFileOffsetHigh As Long, _
    ByVal nNumberOfBytesToLockLow As Long, _
    ByVal nNumberOfBytesToLockHigh As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LockFile = ctypes.windll.kernel32.LockFile
LockFile.restype = wintypes.BOOL
LockFile.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwFileOffsetLow : DWORD
    wintypes.DWORD,  # dwFileOffsetHigh : DWORD
    wintypes.DWORD,  # nNumberOfBytesToLockLow : DWORD
    wintypes.DWORD,  # nNumberOfBytesToLockHigh : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LockFile = Fiddle::Function.new(
  lib['LockFile'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwFileOffsetLow : DWORD
    -Fiddle::TYPE_INT,  # dwFileOffsetHigh : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToLockLow : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToLockHigh : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn LockFile(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwFileOffsetLow: u32,  // DWORD
        dwFileOffsetHigh: u32,  // DWORD
        nNumberOfBytesToLockLow: u32,  // DWORD
        nNumberOfBytesToLockHigh: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool LockFile(IntPtr hFile, uint dwFileOffsetLow, uint dwFileOffsetHigh, uint nNumberOfBytesToLockLow, uint nNumberOfBytesToLockHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LockFile' -Namespace Win32 -PassThru
# $api::LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
#uselib "KERNEL32.dll"
#func global LockFile "LockFile" sptr, sptr, sptr, sptr, sptr
; LockFile hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwFileOffsetLow : DWORD -> "sptr"
; dwFileOffsetHigh : DWORD -> "sptr"
; nNumberOfBytesToLockLow : DWORD -> "sptr"
; nNumberOfBytesToLockHigh : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global LockFile "LockFile" sptr, int, int, int, int
; res = LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
; hFile : HANDLE -> "sptr"
; dwFileOffsetLow : DWORD -> "int"
; dwFileOffsetHigh : DWORD -> "int"
; nNumberOfBytesToLockLow : DWORD -> "int"
; nNumberOfBytesToLockHigh : DWORD -> "int"
; BOOL LockFile(HANDLE hFile, DWORD dwFileOffsetLow, DWORD dwFileOffsetHigh, DWORD nNumberOfBytesToLockLow, DWORD nNumberOfBytesToLockHigh)
#uselib "KERNEL32.dll"
#cfunc global LockFile "LockFile" intptr, int, int, int, int
; res = LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
; hFile : HANDLE -> "intptr"
; dwFileOffsetLow : DWORD -> "int"
; dwFileOffsetHigh : DWORD -> "int"
; nNumberOfBytesToLockLow : DWORD -> "int"
; nNumberOfBytesToLockHigh : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLockFile = kernel32.NewProc("LockFile")
)

// hFile (HANDLE), dwFileOffsetLow (DWORD), dwFileOffsetHigh (DWORD), nNumberOfBytesToLockLow (DWORD), nNumberOfBytesToLockHigh (DWORD)
r1, _, err := procLockFile.Call(
	uintptr(hFile),
	uintptr(dwFileOffsetLow),
	uintptr(dwFileOffsetHigh),
	uintptr(nNumberOfBytesToLockLow),
	uintptr(nNumberOfBytesToLockHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function LockFile(
  hFile: THandle;   // HANDLE
  dwFileOffsetLow: DWORD;   // DWORD
  dwFileOffsetHigh: DWORD;   // DWORD
  nNumberOfBytesToLockLow: DWORD;   // DWORD
  nNumberOfBytesToLockHigh: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'LockFile';
result := DllCall("KERNEL32\LockFile"
    , "Ptr", hFile   ; HANDLE
    , "UInt", dwFileOffsetLow   ; DWORD
    , "UInt", dwFileOffsetHigh   ; DWORD
    , "UInt", nNumberOfBytesToLockLow   ; DWORD
    , "UInt", nNumberOfBytesToLockHigh   ; DWORD
    , "Int")   ; return: BOOL
●LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh) = DLL("KERNEL32.dll", "bool LockFile(void*, dword, dword, dword, dword)")
# 呼び出し: LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
# hFile : HANDLE -> "void*"
# dwFileOffsetLow : DWORD -> "dword"
# dwFileOffsetHigh : DWORD -> "dword"
# nNumberOfBytesToLockLow : DWORD -> "dword"
# nNumberOfBytesToLockHigh : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。