ホーム › Storage.FileSystem › SetFilePointerEx

SetFilePointerEx

関数

ファイルの読み書き位置を64ビット値で移動する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetFilePointerEx(
    HANDLE hFile,
    LONGLONG liDistanceToMove,
    LONGLONG* lpNewFilePointer,   // optional
    SET_FILE_POINTER_MOVE_METHOD dwMoveMethod
);

パラメーター

名前

型

方向

説明

hFile

HANDLE

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

liDistanceToMove

LONGLONG

ファイルポインターを移動するバイト数。正の値はポインターをファイルの先頭方向(前方)に移動し、負の値はポインターを後方に移動します。

lpNewFilePointer

LONGLONG*

outoptional

新しいファイルポインターを受け取る変数へのポインター。このパラメーターが NULL の場合、新しいファイルポインターは返されません。

dwMoveMethod

SET_FILE_POINTER_MOVE_METHOD

ファイルポインター移動の起点。このパラメーターには次のいずれかの値を指定できます。

Value	Meaning
FILE_BEGIN 0	起点はゼロ、すなわちファイルの先頭です。このフラグを指定した場合、 liDistanceToMove パラメーターは符号なしの値として解釈されます。
FILE_CURRENT 1	起点はファイルポインターの現在の値です。
FILE_END 2	起点は現在のファイル終端位置です。

戻り値の型: BOOL

公式ドキュメント

指定したファイルのファイルポインターを移動します。(SetFilePointerEx)

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

この関数が返すファイルポインターは、オーバーラップ読み取り/書き込み操作には使用されません。オーバーラップ操作のオフセットを指定するには、 OVERLAPPED 構造体の Offset メンバーおよび OffsetHigh メンバーを使用してください。

パイプや通信デバイスなどのシーク不可能なデバイスへのハンドルに対しては、SetFilePointerEx 関数を使用できません。hFile のファイルの種類を判別するには、 GetFileType 関数を使用してください。

マルチスレッドアプリケーションでファイルポインターを設定する際は注意してください。共有リソースへのアクセスは同期する必要があります。たとえば、スレッドがファイルハンドルを共有し、ファイルポインターを更新し、ファイルから読み取るアプリケーションでは、この一連の処理をクリティカルセクションオブジェクトまたはミューテックスオブジェクトで保護する必要があります。これらのオブジェクトの詳細については、 Critical Section Objects および Mutex Objects を参照してください。

hFile ハンドルが FILE_FLAG_NO_BUFFERING フラグを設定して開かれている場合、アプリケーションはファイルポインターをセクター境界に揃った位置にのみ移動できます。セクター境界に揃った位置とは、ボリュームのセクターサイズの整数倍となる位置です。アプリケーションは、 GetDiskFreeSpace 関数を呼び出すことでボリュームのセクターサイズを取得できます。FILE_FLAG_NO_BUFFERING を設定して開いたハンドルに対し、アプリケーションがセクター境界に揃わない位置となるような移動バイト数を指定して SetFilePointerEx を呼び出すと、関数は失敗し、 GetLastError は ERROR_INVALID_PARAMETER を返します。詳細については、 File Buffering を参照してください。

なお、ファイルポインターをファイルの終端を超える位置に設定してもエラーにはなりません。 SetEndOfFile、 WriteFile、または WriteFileEx 関数を呼び出すまで、ファイルのサイズは増加しません。書き込み操作を行うと、ファイルのサイズはファイルポインターの位置に書き込んだバッファのサイズを加えた値まで増加し、その間のバイトはゼロで初期化されます。

SetFilePointerEx を使用してファイルの長さを求めることができます。これを行うには、 dwMoveMethod に FILE_END を指定し、位置 0 へシークします。返されるファイルオフセットがファイルの長さになります。ただし、この方法には、現在のファイルポインターを保存できずプログラムがその位置へ戻れなくなるなど、意図しない副作用が生じる可能性があります。代わりに GetFileSizeEx 関数を使用する方が簡単で安全です。

また、SetFilePointerEx を使用して現在のファイルポインターの位置を取得することもできます。これを行うには、移動方法に FILE_CURRENT を、距離に 0 を指定します。

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

Technology	Supported
Server Message Block (SMB) 3.0 protocol	はい
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 SetFilePointerEx(
    HANDLE hFile,
    LONGLONG liDistanceToMove,
    LONGLONG* lpNewFilePointer,   // optional
    SET_FILE_POINTER_MOVE_METHOD dwMoveMethod
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetFilePointerEx(
    IntPtr hFile,   // HANDLE
    long liDistanceToMove,   // LONGLONG
    IntPtr lpNewFilePointer,   // LONGLONG* optional, out
    uint dwMoveMethod   // SET_FILE_POINTER_MOVE_METHOD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFilePointerEx(
    hFile As IntPtr,   ' HANDLE
    liDistanceToMove As Long,   ' LONGLONG
    lpNewFilePointer As IntPtr,   ' LONGLONG* optional, out
    dwMoveMethod As UInteger   ' SET_FILE_POINTER_MOVE_METHOD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' liDistanceToMove : LONGLONG
' lpNewFilePointer : LONGLONG* optional, out
' dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD
Declare PtrSafe Function SetFilePointerEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal liDistanceToMove As LongLong, _
    ByVal lpNewFilePointer As LongPtr, _
    ByVal dwMoveMethod As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetFilePointerEx = ctypes.windll.kernel32.SetFilePointerEx
SetFilePointerEx.restype = wintypes.BOOL
SetFilePointerEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_longlong,  # liDistanceToMove : LONGLONG
    ctypes.POINTER(ctypes.c_longlong),  # lpNewFilePointer : LONGLONG* optional, out
    wintypes.DWORD,  # dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetFilePointerEx = Fiddle::Function.new(
  lib['SetFilePointerEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_LONG_LONG,  # liDistanceToMove : LONGLONG
    Fiddle::TYPE_VOIDP,  # lpNewFilePointer : LONGLONG* optional, out
    -Fiddle::TYPE_INT,  # dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetFilePointerEx(
        hFile: *mut core::ffi::c_void,  // HANDLE
        liDistanceToMove: i64,  // LONGLONG
        lpNewFilePointer: *mut i64,  // LONGLONG* optional, out
        dwMoveMethod: u32  // SET_FILE_POINTER_MOVE_METHOD
    ) -> 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 SetFilePointerEx(IntPtr hFile, long liDistanceToMove, IntPtr lpNewFilePointer, uint dwMoveMethod);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFilePointerEx' -Namespace Win32 -PassThru
# $api::SetFilePointerEx(hFile, liDistanceToMove, lpNewFilePointer, dwMoveMethod)

#uselib "KERNEL32.dll"
#func global SetFilePointerEx "SetFilePointerEx" sptr, sptr, sptr, sptr
; SetFilePointerEx hFile, liDistanceToMove, varptr(lpNewFilePointer), dwMoveMethod   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; liDistanceToMove : LONGLONG -> "sptr"
; lpNewFilePointer : LONGLONG* optional, out -> "sptr"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetFilePointerEx "SetFilePointerEx" sptr, int64, var, int
; res = SetFilePointerEx(hFile, liDistanceToMove, lpNewFilePointer, dwMoveMethod)
; hFile : HANDLE -> "sptr"
; liDistanceToMove : LONGLONG -> "int64"
; lpNewFilePointer : LONGLONG* optional, out -> "var"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "KERNEL32.dll"
#cfunc global SetFilePointerEx "SetFilePointerEx" sptr, int64, sptr, int
; res = SetFilePointerEx(hFile, liDistanceToMove, varptr(lpNewFilePointer), dwMoveMethod)
; hFile : HANDLE -> "sptr"
; liDistanceToMove : LONGLONG -> "int64"
; lpNewFilePointer : LONGLONG* optional, out -> "sptr"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。