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

SetFileInformationByHandle

関数
ハンドルでファイルの各種情報を変更する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetFileInformationByHandle(
    HANDLE hFile,
    FILE_INFO_BY_HANDLE_CLASS FileInformationClass,
    void* lpFileInformation,
    DWORD dwBufferSize
);

パラメーター

名前方向
hFileHANDLEin
FileInformationClassFILE_INFO_BY_HANDLE_CLASSin
lpFileInformationvoid*in
dwBufferSizeDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetFileInformationByHandle = ctypes.windll.kernel32.SetFileInformationByHandle
SetFileInformationByHandle.restype = wintypes.BOOL
SetFileInformationByHandle.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_int,  # FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
    ctypes.POINTER(None),  # lpFileInformation : void*
    wintypes.DWORD,  # dwBufferSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetFileInformationByHandle = Fiddle::Function.new(
  lib['SetFileInformationByHandle'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_INT,  # FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
    Fiddle::TYPE_VOIDP,  # lpFileInformation : void*
    -Fiddle::TYPE_INT,  # dwBufferSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetFileInformationByHandle(
        hFile: *mut core::ffi::c_void,  // HANDLE
        FileInformationClass: i32,  // FILE_INFO_BY_HANDLE_CLASS
        lpFileInformation: *mut (),  // void*
        dwBufferSize: 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 SetFileInformationByHandle(IntPtr hFile, int FileInformationClass, IntPtr lpFileInformation, uint dwBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileInformationByHandle' -Namespace Win32 -PassThru
# $api::SetFileInformationByHandle(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
#uselib "KERNEL32.dll"
#func global SetFileInformationByHandle "SetFileInformationByHandle" sptr, sptr, sptr, sptr
; SetFileInformationByHandle hFile, FileInformationClass, lpFileInformation, dwBufferSize   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> "sptr"
; lpFileInformation : void* -> "sptr"
; dwBufferSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetFileInformationByHandle "SetFileInformationByHandle" sptr, int, sptr, int
; res = SetFileInformationByHandle(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
; hFile : HANDLE -> "sptr"
; FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> "int"
; lpFileInformation : void* -> "sptr"
; dwBufferSize : DWORD -> "int"
; BOOL SetFileInformationByHandle(HANDLE hFile, FILE_INFO_BY_HANDLE_CLASS FileInformationClass, void* lpFileInformation, DWORD dwBufferSize)
#uselib "KERNEL32.dll"
#cfunc global SetFileInformationByHandle "SetFileInformationByHandle" intptr, int, intptr, int
; res = SetFileInformationByHandle(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
; hFile : HANDLE -> "intptr"
; FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> "int"
; lpFileInformation : void* -> "intptr"
; dwBufferSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFileInformationByHandle = kernel32.NewProc("SetFileInformationByHandle")
)

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