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

SetFilePointer

関数
ファイルの読み書き位置を移動する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD SetFilePointer(
    HANDLE hFile,
    INT lDistanceToMove,
    INT* lpDistanceToMoveHigh,   // optional
    SET_FILE_POINTER_MOVE_METHOD dwMoveMethod
);

パラメーター

名前方向説明
hFileHANDLEin

ファイルへのハンドル。

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

lDistanceToMoveINTin

ファイルポインターを移動するバイト数を指定する符号付き値の下位 32 ビット。

lpDistanceToMoveHighNULL でない場合、 lpDistanceToMoveHighlDistanceToMove は移動距離を指定する 1 つの 64 ビット符号付き値を構成します。

lpDistanceToMoveHighNULL の場合、 lDistanceToMove は 32 ビットの符号付き値です。lDistanceToMove が正の値の場合はファイルポインターをファイル内で前方へ移動し、負の値の場合はファイルポインターを後方へ移動します。

lpDistanceToMoveHighINT*inoutoptional

移動距離を表す符号付き 64 ビット値の上位 32 ビットへのポインター。

上位 32 ビットが不要な場合、このポインターは NULL に設定する必要があります。

NULL でない場合、このパラメーターは新しいファイルポインター値の上位 DWORD も受け取ります。詳細については、本トピックの「解説」セクションを参照してください。

dwMoveMethodSET_FILE_POINTER_MOVE_METHODin

ファイルポインター移動の開始点。

このパラメーターには、次のいずれかの値を指定できます。

意味
FILE_BEGIN
0
開始点はゼロ、すなわちファイルの先頭です。
FILE_CURRENT
1
開始点はファイルポインターの現在値です。
FILE_END
2
開始点は現在のファイル終端位置です。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功し、lpDistanceToMoveHighNULL の場合、戻り値は新しいファイルポインターの下位 DWORD です。 注意 関数が INVALID_SET_FILE_POINTER 以外の値を返した場合、 SetFilePointer の呼び出しは成功しています。GetLastError を呼び出す必要はありません。

関数が成功し、lpDistanceToMoveHighNULL でない場合、戻り値は新しいファイルポインターの下位 DWORD であり、 lpDistanceToMoveHigh には新しいファイルポインターの上位 DWORD が格納されます。

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

新しいファイルポインターが負の値になる場合、関数は失敗し、ファイルポインターは移動されず、 GetLastError が返すコードは ERROR_NEGATIVE_SEEK になります。

lpDistanceToMoveHighNULL で、新しいファイル位置が 32 ビット値に収まらない場合、関数は失敗し INVALID_SET_FILE_POINTER を返します。

注意 INVALID_SET_FILE_POINTER は新しいファイルポインターの下位 DWORD としても有効な値であるため、エラーが発生したかどうかを判定するには、関数の戻り値と GetLastError が返すエラーコードの両方を確認する必要があります。エラーが発生した場合、 SetFilePointer の戻り値は INVALID_SET_FILE_POINTER となり、 GetLastErrorNO_ERROR 以外の値を返します。失敗を確認する方法を示すコード例については、本トピックの「解説」セクションを参照してください。

解説(Remarks)

hFile パラメーターの値で識別されるファイルポインターは、オーバーラップ読み取り/書き込み操作には使用されません。

hFile パラメーターは、シーク可能なデバイス(例: ディスクボリューム)に格納されたファイルを参照している必要があります。パイプや通信デバイスなどのシーク不可能なデバイスへのハンドルを指定して SetFilePointer 関数を呼び出すことはサポートされていません。たとえ SetFilePointer 関数がエラーを返さない場合でも同様です。この場合の SetFilePointer 関数の動作は未定義です。

オーバーラップ操作のオフセットを指定するには

hFile のファイル種別を判定するには

ファイルポインターの位置を判定する方法については、 Positioning a File Pointer を参照してください。

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

hFile ハンドルが FILE_FLAG_NO_BUFFERING フラグを設定して開かれている場合、アプリケーションはファイルポインターをセクター境界に整列した位置にのみ移動できます。セクター境界に整列した位置とは、ボリュームのセクターサイズの整数倍となる位置のことです。アプリケーションは GetDiskFreeSpace 関数を呼び出すことでボリュームのセクターサイズを取得できます。

アプリケーションが FILE_FLAG_NO_BUFFERING を設定して開いたハンドルに対し、セクター境界に整列しない位置となる移動距離値で SetFilePointer を呼び出した場合、関数は失敗し、 GetLastErrorERROR_INVALID_PARAMETER を返します。

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

戻り値が INVALID_SET_FILE_POINTER で、かつ lpDistanceToMoveHighNULL でない場合、アプリケーションは GetLastError を呼び出して、関数が成功したか失敗したかを判定する必要があります。次のコード例はそのシナリオを示します。

  // Case One: calling the function with lpDistanceToMoveHigh == NULL 

  // Try to move hFile file pointer some distance  
  DWORD dwPtr = SetFilePointer( hFile, 
                                lDistance, 
                                NULL, 
                                FILE_BEGIN ); 
   
  if (dwPtr == INVALID_SET_FILE_POINTER) // Test for failure
   { 
    // Obtain the error code. 
    DWORD dwError = GetLastError() ; 
   
    // Deal with failure 
    // . . . 
   
   } // End of error handler 


  //
  // Case Two: calling the function with lpDistanceToMoveHigh != NULL

  // Try to move hFile file pointer a huge distance 
  DWORD dwPtrLow = SetFilePointer( hFile, 
                                   lDistLow, 
                                   &lDistHigh, 
                                   FILE_BEGIN ); 
   
  // Test for failure
  if ( dwPtrLow == INVALID_SET_FILE_POINTER && 
       GetLastError() != NO_ERROR )
   {
    // Deal with failure
    // . . .

   } // End of error handler

パラメーター lpDistanceToMoveHigh は巨大なファイルを操作するために使用されますが、どのようなサイズのファイルを移動する場合でもこのパラメーターの値を設定すべきです。NULL に設定した場合、すべてのファイルポインター値が符号付き値であるため、 lDistanceToMove の最大値は 2^31–2(2 ギガバイト引く 2)になります。したがって、ファイルがそのサイズまで増大するわずかな可能性でもあるなら、そのファイルを巨大なファイルとして扱い、64 ビットのファイルポインターで操作することが最善です。NTFS ファイルシステム上の ファイル圧縮スパースファイル を使用すると、基となるボリュームがそれほど大きくない場合でも大きなファイルを作成できます。

lpDistanceToMoveHighNULL でない場合、 lpDistanceToMoveHighlDistanceToMove は 1 つの 64 ビット符号付き値を構成します。lDistanceToMove パラメーターはその値の下位 32 ビットとして扱われ、lpDistanceToMoveHigh は上位 32 ビットとして扱われます。つまり、 lpDistanceToMoveHighlDistanceToMove の符号拡張になります。

ファイルポインターをゼロから 2 ギガバイトまで移動するには、lpDistanceToMoveHighNULL または lDistanceToMove の符号拡張のいずれかに設定する必要があります。ポインターを 2 ギガバイトを超えて移動するには、lpDistanceToMoveHighlDistanceToMove を 1 つの 64 ビット量として使用します。たとえば、2 ギガバイトから 4 ギガバイトの範囲で移動するには、lpDistanceToMoveHigh の内容をゼロに設定するか、lDistanceToMove の負の符号拡張として –1 に設定します。

64 ビットのファイルポインターを扱うには、LONG を宣言し、それを 64 ビットファイルポインターの上位半分として扱い、そのアドレスを lpDistanceToMoveHigh に渡すことができます。ただしこの方法では、2 つの異なる変数を 1 つの論理単位として扱う必要があり、エラーの原因となることがあります。LARGE_INTEGER 構造体を使用して 64 ビット値を作成し、共用体の適切な要素を使って 2 つの 32 ビット値を渡すのが最善です。

また、SetFilePointer へのインターフェイスを隠蔽する関数を使用するのが最善です。次のコード例はそのシナリオを示します。

__int64 myFileSeek (HANDLE hf, __int64 distance, DWORD MoveMethod)
{
   LARGE_INTEGER li;

   li.QuadPart = distance;

   li.LowPart = SetFilePointer (hf, 
                                li.LowPart, 
                                &li.HighPart, 
                                MoveMethod);

   if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() 
       != NO_ERROR)
   {
      li.QuadPart = -1;
   }

   return li.QuadPart;
}

SetFilePointer を使用してファイルの長さを判定できます。これを行うには、dwMoveMethodFILE_END を指定し、位置ゼロへシークします。返されるファイルオフセットがファイルの長さです。ただし、この手法には意図しない副作用が生じる可能性があります。たとえば、現在のファイルポインターを保存しないために、プログラムがその位置に戻れなくなることがあります。代わりに GetFileSize を使用するのが最善です。

また、SetFilePointer 関数を使用して現在のファイルポインター位置を照会することもできます。これを行うには、移動方法に FILE_CURRENT を指定し、距離をゼロに指定します。

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) はい

ファイルを追記するコード例については、 Appending One File to Another File を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD SetFilePointer(
    HANDLE hFile,
    INT lDistanceToMove,
    INT* lpDistanceToMoveHigh,   // optional
    SET_FILE_POINTER_MOVE_METHOD dwMoveMethod
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint SetFilePointer(
    IntPtr hFile,   // HANDLE
    int lDistanceToMove,   // INT
    IntPtr lpDistanceToMoveHigh,   // INT* optional, in/out
    uint dwMoveMethod   // SET_FILE_POINTER_MOVE_METHOD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFilePointer(
    hFile As IntPtr,   ' HANDLE
    lDistanceToMove As Integer,   ' INT
    lpDistanceToMoveHigh As IntPtr,   ' INT* optional, in/out
    dwMoveMethod As UInteger   ' SET_FILE_POINTER_MOVE_METHOD
) As UInteger
End Function
' hFile : HANDLE
' lDistanceToMove : INT
' lpDistanceToMoveHigh : INT* optional, in/out
' dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD
Declare PtrSafe Function SetFilePointer Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lDistanceToMove As Long, _
    ByVal lpDistanceToMoveHigh 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

SetFilePointer = ctypes.windll.kernel32.SetFilePointer
SetFilePointer.restype = wintypes.DWORD
SetFilePointer.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_int,  # lDistanceToMove : INT
    ctypes.POINTER(ctypes.c_int),  # lpDistanceToMoveHigh : INT* optional, in/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')
SetFilePointer = Fiddle::Function.new(
  lib['SetFilePointer'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_INT,  # lDistanceToMove : INT
    Fiddle::TYPE_VOIDP,  # lpDistanceToMoveHigh : INT* optional, in/out
    -Fiddle::TYPE_INT,  # dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetFilePointer(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lDistanceToMove: i32,  // INT
        lpDistanceToMoveHigh: *mut i32,  // INT* optional, in/out
        dwMoveMethod: u32  // SET_FILE_POINTER_MOVE_METHOD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint SetFilePointer(IntPtr hFile, int lDistanceToMove, IntPtr lpDistanceToMoveHigh, uint dwMoveMethod);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFilePointer' -Namespace Win32 -PassThru
# $api::SetFilePointer(hFile, lDistanceToMove, lpDistanceToMoveHigh, dwMoveMethod)
#uselib "KERNEL32.dll"
#func global SetFilePointer "SetFilePointer" sptr, sptr, sptr, sptr
; SetFilePointer hFile, lDistanceToMove, varptr(lpDistanceToMoveHigh), dwMoveMethod   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lDistanceToMove : INT -> "sptr"
; lpDistanceToMoveHigh : INT* optional, in/out -> "sptr"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetFilePointer "SetFilePointer" sptr, int, var, int
; res = SetFilePointer(hFile, lDistanceToMove, lpDistanceToMoveHigh, dwMoveMethod)
; hFile : HANDLE -> "sptr"
; lDistanceToMove : INT -> "int"
; lpDistanceToMoveHigh : INT* optional, in/out -> "var"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD SetFilePointer(HANDLE hFile, INT lDistanceToMove, INT* lpDistanceToMoveHigh, SET_FILE_POINTER_MOVE_METHOD dwMoveMethod)
#uselib "KERNEL32.dll"
#cfunc global SetFilePointer "SetFilePointer" intptr, int, var, int
; res = SetFilePointer(hFile, lDistanceToMove, lpDistanceToMoveHigh, dwMoveMethod)
; hFile : HANDLE -> "intptr"
; lDistanceToMove : INT -> "int"
; lpDistanceToMoveHigh : INT* optional, in/out -> "var"
; dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFilePointer = kernel32.NewProc("SetFilePointer")
)

// hFile (HANDLE), lDistanceToMove (INT), lpDistanceToMoveHigh (INT* optional, in/out), dwMoveMethod (SET_FILE_POINTER_MOVE_METHOD)
r1, _, err := procSetFilePointer.Call(
	uintptr(hFile),
	uintptr(lDistanceToMove),
	uintptr(lpDistanceToMoveHigh),
	uintptr(dwMoveMethod),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SetFilePointer(
  hFile: THandle;   // HANDLE
  lDistanceToMove: Integer;   // INT
  lpDistanceToMoveHigh: Pointer;   // INT* optional, in/out
  dwMoveMethod: DWORD   // SET_FILE_POINTER_MOVE_METHOD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'SetFilePointer';
result := DllCall("KERNEL32\SetFilePointer"
    , "Ptr", hFile   ; HANDLE
    , "Int", lDistanceToMove   ; INT
    , "Ptr", lpDistanceToMoveHigh   ; INT* optional, in/out
    , "UInt", dwMoveMethod   ; SET_FILE_POINTER_MOVE_METHOD
    , "UInt")   ; return: DWORD
●SetFilePointer(hFile, lDistanceToMove, lpDistanceToMoveHigh, dwMoveMethod) = DLL("KERNEL32.dll", "dword SetFilePointer(void*, int, void*, dword)")
# 呼び出し: SetFilePointer(hFile, lDistanceToMove, lpDistanceToMoveHigh, dwMoveMethod)
# hFile : HANDLE -> "void*"
# lDistanceToMove : INT -> "int"
# lpDistanceToMoveHigh : INT* optional, in/out -> "void*"
# dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetFilePointerNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Int32>, Uint32);
typedef SetFilePointerDart = int Function(Pointer<Void>, int, Pointer<Int32>, int);
final SetFilePointer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetFilePointerNative, SetFilePointerDart>('SetFilePointer');
// hFile : HANDLE -> Pointer<Void>
// lDistanceToMove : INT -> Int32
// lpDistanceToMoveHigh : INT* optional, in/out -> Pointer<Int32>
// dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFilePointer(
  hFile: THandle;   // HANDLE
  lDistanceToMove: Integer;   // INT
  lpDistanceToMoveHigh: Pointer;   // INT* optional, in/out
  dwMoveMethod: DWORD   // SET_FILE_POINTER_MOVE_METHOD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'SetFilePointer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetFilePointer"
  c_SetFilePointer :: Ptr () -> Int32 -> Ptr Int32 -> Word32 -> IO Word32
-- hFile : HANDLE -> Ptr ()
-- lDistanceToMove : INT -> Int32
-- lpDistanceToMoveHigh : INT* optional, in/out -> Ptr Int32
-- dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setfilepointer =
  foreign "SetFilePointer"
    ((ptr void) @-> int32_t @-> (ptr int32_t) @-> uint32_t @-> returning uint32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lDistanceToMove : INT -> int32_t *)
(* lpDistanceToMoveHigh : INT* optional, in/out -> (ptr int32_t) *)
(* dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetFilePointer" set-file-pointer :convention :stdcall) :uint32
  (h-file :pointer)   ; HANDLE
  (l-distance-to-move :int32)   ; INT
  (lp-distance-to-move-high :pointer)   ; INT* optional, in/out
  (dw-move-method :uint32))   ; SET_FILE_POINTER_MOVE_METHOD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFilePointer = Win32::API::More->new('KERNEL32',
    'DWORD SetFilePointer(HANDLE hFile, int lDistanceToMove, LPVOID lpDistanceToMoveHigh, DWORD dwMoveMethod)');
# my $ret = $SetFilePointer->Call($hFile, $lDistanceToMove, $lpDistanceToMoveHigh, $dwMoveMethod);
# hFile : HANDLE -> HANDLE
# lDistanceToMove : INT -> int
# lpDistanceToMoveHigh : INT* optional, in/out -> LPVOID
# dwMoveMethod : SET_FILE_POINTER_MOVE_METHOD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型