BackupSeek

関数

バックアップストリーム内を指定バイト分シークする。

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

シグネチャ

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

BOOL BackupSeek(
    HANDLE hFile,
    DWORD dwLowBytesToSeek,
    DWORD dwHighBytesToSeek,
    DWORD* lpdwLowByteSeeked,
    DWORD* lpdwHighByteSeeked,
    void** lpContext
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイルまたはディレクトリへのハンドル。このハンドルは CreateFile 関数を使用して作成します。ハンドルは同期(非オーバーラップ)である必要があります。つまり、CreateFile を呼び出す際に FILE_FLAG_OVERLAPPED フラグを設定してはなりません。この関数は受け取ったハンドルが同期であるかどうかを検証しないため、同期ハンドルに対してエラーコードを返すことはありませんが、非同期(オーバーラップ)ハンドルを指定して呼び出すと、デバッグが非常に困難な微妙なエラーが発生する可能性があります。
dwLowBytesToSeek	DWORD	in	シークするバイト数の下位部分。
dwHighBytesToSeek	DWORD	in	シークするバイト数の上位部分。
lpdwLowByteSeeked	DWORD*	out	関数が実際にシークしたバイト数の下位ビットを受け取る変数へのポインター。
lpdwHighByteSeeked	DWORD*	out	関数が実際にシークしたバイト数の上位ビットを受け取る変数へのポインター。
lpContext	void**	inout	関数が使用する内部データ構造へのポインター。この構造は、 BackupRead 関数または BackupWrite 関数によって初期化されたものと同じ構造である必要があります。アプリケーションはこの構造の内容に手を加えてはなりません。

戻り値の型: BOOL

公式ドキュメント

BackupRead または BackupWrite 関数で最初にアクセスしたデータストリーム内を前方にシークします。

戻り値

要求された量だけシークできた場合、関数は 0 以外の値を返します。

要求された量だけシークできなかった場合、関数は 0 を返します。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

アプリケーションは BackupSeek 関数を使用して、エラーの原因となるデータストリームの一部をスキップします。この関数はストリームヘッダーをまたいでシークすることはできません。たとえば、この関数を使用してストリーム名をスキップすることはできません。アプリケーションがサブストリームの終端を超えてシークしようとすると、関数は失敗し、lpdwLowByteSeeked パラメーターと lpdwHighByteSeeked パラメーターには関数が実際にシークしたバイト数が示され、ファイル位置は次のストリームヘッダーの先頭に置かれます。

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

各言語での呼び出し定義

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

BOOL BackupSeek(
    HANDLE hFile,
    DWORD dwLowBytesToSeek,
    DWORD dwHighBytesToSeek,
    DWORD* lpdwLowByteSeeked,
    DWORD* lpdwHighByteSeeked,
    void** lpContext
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool BackupSeek(
    IntPtr hFile,   // HANDLE
    uint dwLowBytesToSeek,   // DWORD
    uint dwHighBytesToSeek,   // DWORD
    out uint lpdwLowByteSeeked,   // DWORD* out
    out uint lpdwHighByteSeeked,   // DWORD* out
    IntPtr lpContext   // void** in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BackupSeek(
    hFile As IntPtr,   ' HANDLE
    dwLowBytesToSeek As UInteger,   ' DWORD
    dwHighBytesToSeek As UInteger,   ' DWORD
    <Out> ByRef lpdwLowByteSeeked As UInteger,   ' DWORD* out
    <Out> ByRef lpdwHighByteSeeked As UInteger,   ' DWORD* out
    lpContext As IntPtr   ' void** in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' dwLowBytesToSeek : DWORD
' dwHighBytesToSeek : DWORD
' lpdwLowByteSeeked : DWORD* out
' lpdwHighByteSeeked : DWORD* out
' lpContext : void** in/out
Declare PtrSafe Function BackupSeek Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwLowBytesToSeek As Long, _
    ByVal dwHighBytesToSeek As Long, _
    ByRef lpdwLowByteSeeked As Long, _
    ByRef lpdwHighByteSeeked As Long, _
    ByVal lpContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BackupSeek = ctypes.windll.kernel32.BackupSeek
BackupSeek.restype = wintypes.BOOL
BackupSeek.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwLowBytesToSeek : DWORD
    wintypes.DWORD,  # dwHighBytesToSeek : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwLowByteSeeked : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # lpdwHighByteSeeked : DWORD* out
    ctypes.c_void_p,  # lpContext : void** in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
BackupSeek = Fiddle::Function.new(
  lib['BackupSeek'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwLowBytesToSeek : DWORD
    -Fiddle::TYPE_INT,  # dwHighBytesToSeek : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwLowByteSeeked : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpdwHighByteSeeked : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpContext : void** in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn BackupSeek(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwLowBytesToSeek: u32,  // DWORD
        dwHighBytesToSeek: u32,  // DWORD
        lpdwLowByteSeeked: *mut u32,  // DWORD* out
        lpdwHighByteSeeked: *mut u32,  // DWORD* out
        lpContext: *mut *mut ()  // void** in/out
    ) -> 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 BackupSeek(IntPtr hFile, uint dwLowBytesToSeek, uint dwHighBytesToSeek, out uint lpdwLowByteSeeked, out uint lpdwHighByteSeeked, IntPtr lpContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_BackupSeek' -Namespace Win32 -PassThru
# $api::BackupSeek(hFile, dwLowBytesToSeek, dwHighBytesToSeek, lpdwLowByteSeeked, lpdwHighByteSeeked, lpContext)

#uselib "KERNEL32.dll"
#func global BackupSeek "BackupSeek" sptr, sptr, sptr, sptr, sptr, sptr
; BackupSeek hFile, dwLowBytesToSeek, dwHighBytesToSeek, varptr(lpdwLowByteSeeked), varptr(lpdwHighByteSeeked), lpContext   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwLowBytesToSeek : DWORD -> "sptr"
; dwHighBytesToSeek : DWORD -> "sptr"
; lpdwLowByteSeeked : DWORD* out -> "sptr"
; lpdwHighByteSeeked : DWORD* out -> "sptr"
; lpContext : void** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global BackupSeek "BackupSeek" sptr, int, int, var, var, sptr
; res = BackupSeek(hFile, dwLowBytesToSeek, dwHighBytesToSeek, lpdwLowByteSeeked, lpdwHighByteSeeked, lpContext)
; hFile : HANDLE -> "sptr"
; dwLowBytesToSeek : DWORD -> "int"
; dwHighBytesToSeek : DWORD -> "int"
; lpdwLowByteSeeked : DWORD* out -> "var"
; lpdwHighByteSeeked : DWORD* out -> "var"
; lpContext : void** in/out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global BackupSeek "BackupSeek" sptr, int, int, sptr, sptr, sptr
; res = BackupSeek(hFile, dwLowBytesToSeek, dwHighBytesToSeek, varptr(lpdwLowByteSeeked), varptr(lpdwHighByteSeeked), lpContext)
; hFile : HANDLE -> "sptr"
; dwLowBytesToSeek : DWORD -> "int"
; dwHighBytesToSeek : DWORD -> "int"
; lpdwLowByteSeeked : DWORD* out -> "sptr"
; lpdwHighByteSeeked : DWORD* out -> "sptr"
; lpContext : void** in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。