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

SetEndOfFile

関数
現在のファイルポインタ位置をファイル終端に設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetEndOfFile(
    HANDLE hFile
);

パラメーター

名前方向説明
hFileHANDLEin

拡張または切り詰めるファイルのハンドル。

このファイルハンドルは GENERIC_WRITE アクセス権で作成されている必要があります。詳細については、 File Security and Access Rights を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したファイルの物理ファイルサイズを、現在のファイルポインターの位置に設定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

SetEndOfFile 関数は、ファイルを切り詰めたり拡張したりするために使用できます。ファイルを拡張した場合、元のファイル末尾と新しいファイル末尾の間のファイル内容は未定義です。

各ファイルストリームには次のものがあります。

SetEndOfFile 関数はファイルサイズを設定します。有効データ長を設定するには SetFileValidData を使用します。

hFile に対するファイルマッピングオブジェクトを作成するために CreateFileMapping を呼び出した場合は、SetEndOfFile を呼び出す前に、まず UnmapViewOfFile を呼び出してすべてのビューのマッピングを解除し、さらに CloseHandle を呼び出してファイルマッピングオブジェクトを閉じる必要があります。

トランザクション処理された操作

ハンドルにトランザクションがバインドされている場合、ファイル末尾位置の変更はトランザクション処理されます。

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 の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetEndOfFile = kernel32.NewProc("SetEndOfFile")
)

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

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

typedef SetEndOfFileNative = Int32 Function(Pointer<Void>);
typedef SetEndOfFileDart = int Function(Pointer<Void>);
final SetEndOfFile = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetEndOfFileNative, SetEndOfFileDart>('SetEndOfFile');
// hFile : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetEndOfFile(
  hFile: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetEndOfFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetEndOfFile"
  c_SetEndOfFile :: Ptr () -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setendoffile =
  foreign "SetEndOfFile"
    ((ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetEndOfFile" set-end-of-file :convention :stdcall) :int32
  (h-file :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetEndOfFile = Win32::API::More->new('KERNEL32',
    'BOOL SetEndOfFile(HANDLE hFile)');
# my $ret = $SetEndOfFile->Call($hFile);
# hFile : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目