SetFileValidData
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetFileValidData(
HANDLE hFile,
LONGLONG ValidDataLength
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hFile | HANDLE | in | ファイルへのハンドル。ファイルは GENERIC_WRITE アクセス権で開かれ、かつ SE_MANAGE_VOLUME_NAME 特権が有効になっている必要があります。詳細については、 File Security and Access Rights を参照してください。 注意 ファイルは、ネットワークファイル、圧縮ファイル、スパースファイル、トランザクションファイルのいずれであってもなりません。
|
| ValidDataLength | LONGLONG | in | 新しい有効データ長。 このパラメーターは、現在の有効データ長より大きく、かつ現在のファイルサイズより小さい正の値である必要があります。 |
戻り値の型: BOOL
公式ドキュメント
指定したファイルの有効データ長を設定します。この関数が役立つのは、ごく限られた場面のみです。詳細については、「解説」セクションを参照してください。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
SetFileValidData 関数は、ファイルの論理的な終端を設定します。ファイルのサイズを設定するには、SetEndOfFile 関数を使用します。物理的なファイルサイズは、ファイルの終端とも呼ばれます。
各ファイルストリームは、次のプロパティを持ちます。
- ファイルサイズ: ファイル内のデータのサイズ(バイト単位)。
- 割り当てサイズ: ディスク上でファイルに割り当てられた領域のサイズ。常にクラスターサイズの偶数倍になります。
- 有効データ長: ファイル内で実際に書き込まれているデータの長さ(バイト単位)。この値は常にファイルサイズ以下です。
SetFileValidData 関数を使用すると、ファイルへ非連続的に書き込む際にデータをゼロで埋める処理を回避できます。この関数は、ファイルに書き込むことなくファイル内のデータを有効にします。その結果、パフォーマンスの向上が得られる場合がありますが、以前に存在していたファイルのディスク上の既存データが、意図しない読み取り元に意図せず公開されてしまう可能性があります。次の段落で、この潜在的なセキュリティおよびプライバシー上の問題について、より詳しく説明します。
呼び出し元は、ファイルを最初に開くときに SE_MANAGE_VOLUME_NAME 特権が有効になっている必要があります。アプリケーションは、SE_MANAGE_VOLUME_NAME アクセスを持つエンティティのみにアクセスを制限したファイルに対してのみ SetFileValidData を呼び出すべきです。アプリケーションは、ファイルの未書き込み範囲が決して公開されないようにする必要があります。そうしないと、次のようなセキュリティ上の問題が発生する可能性があります。
SetFileValidData をファイルに対して使用すると、ファイルに割り当てられたクラスターをゼロで埋めないことによって潜在的なパフォーマンス向上が得られます。そのため、ファイルからの読み取りでは、割り当てられたクラスターに含まれている内容(他のユーザーのコンテンツである可能性がある内容)がそのまま返されます。この時点では、これは必ずしもセキュリティ上の問題ではありません。SetFileValidData を成功させるには呼び出し元が SE_MANAGE_VOLUME_NAME 特権を持っている必要があり、そのようなユーザーはディスク上のすべてのデータを読み取ることができるためです。ただし、次の条件が満たされる場合、この呼び出し元は SE_MANAGE_VOLUME_PRIVILEGE 特権を取得できない他のユーザーに、このデータを意図せず公開してしまう可能性があります。
- ファイルが他の読み取り元を拒否する共有モードで開かれていなかった場合、特権を持たないユーザーがそのファイルを開いて、公開されたデータを読み取ることができます。
- 呼び出しで指定された ValidDataLength まで呼び出し元が書き込みを完了する前にシステムが応答を停止した場合、再起動後に、そのような特権を持たないユーザーがファイルを開いて公開されたコンテンツを読み取ることができます。
SetFileValidData の呼び出し元が十分に制限的なアクセス制御でファイルを開いていた場合、上記の条件は当てはまりません。ただし、SetFileValidData で拡張された部分的にしか書き込まれていないファイル(つまり、呼び出しで指定された ValidDataLength まで書き込みが完了していないファイル)には、さらに別の潜在的なプライバシーまたはセキュリティ上の脆弱性が存在します。管理者がそのファイルを、制限的な ACL 権限で適切に制御されていない場所へコピーすることで、拡張された領域のデータを許可されていない読み取りに意図せず公開してしまう可能性があります。
これらの理由から、また後述するパフォーマンス上の考慮事項とあわせて、SetFileValidData は汎用的な用途には推奨されません。
セキュリティおよびアクセス特権の詳細については、 Running with Special Privileges および File Security and Access Rights を参照してください。
SetFileValidData 関数は、ごく特定の状況下で大きなファイルを作成し、後続のファイル I/O のパフォーマンスを他の方法よりも向上させるために使用できます。具体的には、ファイルの拡張部分が大きく、データベース型のアプリケーションのようにランダムに書き込まれる場合、SetEndOfFile を使用してランダムに書き込むよりも、ファイルを拡張して書き込むのにかかる時間が速くなります。それ以外のほとんどの状況では、SetFileValidData を使用してもパフォーマンスの向上は通常得られず、場合によってはパフォーマンスの低下を招くこともあります。
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) | はい |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetFileValidData(
HANDLE hFile,
LONGLONG ValidDataLength
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetFileValidData(
IntPtr hFile, // HANDLE
long ValidDataLength // LONGLONG
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFileValidData(
hFile As IntPtr, ' HANDLE
ValidDataLength As Long ' LONGLONG
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hFile : HANDLE
' ValidDataLength : LONGLONG
Declare PtrSafe Function SetFileValidData Lib "kernel32" ( _
ByVal hFile As LongPtr, _
ByVal ValidDataLength As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetFileValidData = ctypes.windll.kernel32.SetFileValidData
SetFileValidData.restype = wintypes.BOOL
SetFileValidData.argtypes = [
wintypes.HANDLE, # hFile : HANDLE
ctypes.c_longlong, # ValidDataLength : LONGLONG
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetFileValidData = Fiddle::Function.new(
lib['SetFileValidData'],
[
Fiddle::TYPE_VOIDP, # hFile : HANDLE
Fiddle::TYPE_LONG_LONG, # ValidDataLength : LONGLONG
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetFileValidData(
hFile: *mut core::ffi::c_void, // HANDLE
ValidDataLength: i64 // LONGLONG
) -> 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 SetFileValidData(IntPtr hFile, long ValidDataLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileValidData' -Namespace Win32 -PassThru
# $api::SetFileValidData(hFile, ValidDataLength)#uselib "KERNEL32.dll"
#func global SetFileValidData "SetFileValidData" sptr, sptr
; SetFileValidData hFile, ValidDataLength ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; ValidDataLength : LONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetFileValidData "SetFileValidData" sptr, int64
; res = SetFileValidData(hFile, ValidDataLength)
; hFile : HANDLE -> "sptr"
; ValidDataLength : LONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。; BOOL SetFileValidData(HANDLE hFile, LONGLONG ValidDataLength)
#uselib "KERNEL32.dll"
#cfunc global SetFileValidData "SetFileValidData" intptr, int64
; res = SetFileValidData(hFile, ValidDataLength)
; hFile : HANDLE -> "intptr"
; ValidDataLength : LONGLONG -> "int64"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetFileValidData = kernel32.NewProc("SetFileValidData")
)
// hFile (HANDLE), ValidDataLength (LONGLONG)
r1, _, err := procSetFileValidData.Call(
uintptr(hFile),
uintptr(ValidDataLength),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetFileValidData(
hFile: THandle; // HANDLE
ValidDataLength: Int64 // LONGLONG
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFileValidData';result := DllCall("KERNEL32\SetFileValidData"
, "Ptr", hFile ; HANDLE
, "Int64", ValidDataLength ; LONGLONG
, "Int") ; return: BOOL●SetFileValidData(hFile, ValidDataLength) = DLL("KERNEL32.dll", "bool SetFileValidData(void*, int64)")
# 呼び出し: SetFileValidData(hFile, ValidDataLength)
# hFile : HANDLE -> "void*"
# ValidDataLength : LONGLONG -> "int64"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetFileValidData(
hFile: ?*anyopaque, // HANDLE
ValidDataLength: i64 // LONGLONG
) callconv(std.os.windows.WINAPI) i32;proc SetFileValidData(
hFile: pointer, # HANDLE
ValidDataLength: int64 # LONGLONG
): int32 {.importc: "SetFileValidData", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetFileValidData(
void* hFile, // HANDLE
long ValidDataLength // LONGLONG
);ccall((:SetFileValidData, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Int64),
hFile, ValidDataLength)
# hFile : HANDLE -> Ptr{Cvoid}
# ValidDataLength : LONGLONG -> Int64
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetFileValidData(
void* hFile,
int64_t ValidDataLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFileValidData(hFile, ValidDataLength)
-- hFile : HANDLE
-- ValidDataLength : LONGLONG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetFileValidData = lib.func('__stdcall', 'SetFileValidData', 'int32_t', ['void *', 'int64_t']);
// SetFileValidData(hFile, ValidDataLength)
// hFile : HANDLE -> 'void *'
// ValidDataLength : LONGLONG -> 'int64_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetFileValidData: { parameters: ["pointer", "i64"], result: "i32" },
});
// lib.symbols.SetFileValidData(hFile, ValidDataLength)
// hFile : HANDLE -> "pointer"
// ValidDataLength : LONGLONG -> "i64"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetFileValidData(
void* hFile,
int64_t ValidDataLength);
C, "KERNEL32.dll");
// $ffi->SetFileValidData(hFile, ValidDataLength);
// hFile : HANDLE
// ValidDataLength : LONGLONG
// 構造体/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);
boolean SetFileValidData(
Pointer hFile, // HANDLE
long ValidDataLength // LONGLONG
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetFileValidData = SetFileValidData(
hFile : Void*, # HANDLE
ValidDataLength : Int64 # LONGLONG
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetFileValidDataNative = Int32 Function(Pointer<Void>, Int64);
typedef SetFileValidDataDart = int Function(Pointer<Void>, int);
final SetFileValidData = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetFileValidDataNative, SetFileValidDataDart>('SetFileValidData');
// hFile : HANDLE -> Pointer<Void>
// ValidDataLength : LONGLONG -> Int64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetFileValidData(
hFile: THandle; // HANDLE
ValidDataLength: Int64 // LONGLONG
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFileValidData';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetFileValidData"
c_SetFileValidData :: Ptr () -> Int64 -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- ValidDataLength : LONGLONG -> Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setfilevaliddata =
foreign "SetFileValidData"
((ptr void) @-> int64_t @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* ValidDataLength : LONGLONG -> int64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetFileValidData" set-file-valid-data :convention :stdcall) :int32
(h-file :pointer) ; HANDLE
(valid-data-length :int64)) ; LONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetFileValidData = Win32::API::More->new('KERNEL32',
'BOOL SetFileValidData(HANDLE hFile, INT64 ValidDataLength)');
# my $ret = $SetFileValidData->Call($hFile, $ValidDataLength);
# hFile : HANDLE -> HANDLE
# ValidDataLength : LONGLONG -> INT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetEndOfFile — 現在のファイルポインタ位置をファイル終端に設定する。