Win32 API 日本語リファレンス
ホームSystem.Ioctl › MARK_HANDLE_INFO

MARK_HANDLE_INFO

構造体
サイズx64: 24 バイト / x86: 12 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
Anonymous_Anonymous_e__Union4+0+0UsnSourceInfoとCopyNumberを共用する無名共用体。用途に応じいずれかを使用する。
VolumeHandleHANDLE8/4+8+4

ファイルまたはディレクトリが存在するボリュームへのボリュームハンドルです。ボリュームハンドルの取得方法の詳細については、「解説」セクションを参照してください。

このハンドルは、この操作に対する特権を確認するために必要です。

呼び出し元は SE_MANAGE_VOLUME_NAME 特権を持っていなければなりません。詳細については、Privileges を参照してください。

HandleInfoDWORD4+16+8

VolumeHandle メンバーのハンドル値によって識別されるファイルまたはディレクトリに関する追加情報を指定するフラグです。

意味
MARK_HANDLE_PROTECT_CLUSTERS
0x00000001
そのファイルは、ハンドルが閉じられるまでデフラグできないものとしてマークされます。

MARK_HANDLE_PROTECT_CLUSTERS でマークされたハンドルがいったん閉じられると、そのファイルのクラスターが移動しないという保証はありません。

MARK_HANDLE_TXF_SYSTEM_LOG
0x00000004
そのファイルは、ハンドルが閉じられるまでデフラグできないものとしてマークされます。

Windows Server 2003: このフラグは Windows Server 2003 with SP1 以降でのみサポートされます。

Windows XP: このフラグはサポートされません。

MARK_HANDLE_NOT_TXF_SYSTEM_LOG
0x00000008
そのファイルは、ハンドルが閉じられるまでデフラグできないものとしてマークされます。

Windows Server 2003: このフラグは Windows Server 2003 with SP1 以降でのみサポートされます。

Windows XP: このフラグはサポートされません。

MARK_HANDLE_REALTIME
0x00000020
実際のファイルの種類にかかわらず、そのファイルはリアルタイム読み取り動作用としてマークされます。このフラグでマークされたファイルは、バッファーなし I/O 用に開かなければなりません。

Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: このフラグはサポートされません。

MARK_HANDLE_NOT_REALTIME
0x00000040
MARK_HANDLE_REALTIME フラグを使用して以前にリアルタイム読み取り動作用としてマークされたファイルは、このフラグを使用してマークを解除し、リアルタイム動作を取り除くことができます。このフラグでマークされたファイルは、バッファーなし I/O 用に開かなければなりません。

Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: このフラグはサポートされません。

MARK_HANDLE_READ_COPY
0x00000080
読み取りに CopyNumber メンバーで指定されたコピー番号を使用することを示します。このフラグでマークされたファイルは、バッファーなし I/O 用に開かなければなりません。

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: このフラグは Windows 8 および Windows Server 2012 以降でのみサポートされます。

MARK_HANDLE_NOT_READ_COPY
0x00000100
MARK_HANDLE_READ_COPY フラグを使用して以前に読み取りコピー動作用としてマークされたファイルは、このフラグを使用してマークを解除し、読み取りコピー動作を取り除くことができます。このフラグでマークされたファイルは、バッファーなし I/O 用に開かなければなりません。

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: このフラグは Windows 8 および Windows Server 2012 以降でのみサポートされます。

MARK_HANDLE_RETURN_PURGE_FAILURE
0x00000400
メモリマップド I/O やキャッシュ I/O と非キャッシュ I/O を混在させている場合、非キャッシュ I/O が発行されると、システムはその非キャッシュ I/O の範囲についてメモリマッピングをパージしようとします。これらのパージが失敗しても、システムは通常その失敗を呼び出し元に返さないため、状態が破損する可能性があります (このような使い方をしないようドキュメントで説明しているのはこのためです)。このフラグは、指定されたハンドルについてパージの失敗を返すようシステムに指示し、アプリケーションがこの状況をより適切に処理できるようにします。

このフラグは Windows 8 および Windows Server 2012 以降でのみサポートされます。

MARK_HANDLE_DISABLE_FILE_METADATA_OPTIMIZATION
0x00001000
NTFS では、断片化が激しいファイルは、そのファイルのすべてのエクステントを記述するために複数の MFT レコードを使用します。この子 MFT レコード (FRS レコードとも呼ばれます) のリストは、属性リストと呼ばれる構造体によって管理されます。属性リストのサイズは 128K に制限されています。属性リストのサイズが一定のしきい値に達すると、NTFS はエクステントに対するバックグラウンド圧縮を開始し、使用される子 FRS レコードの数が最小になるようにします。このフラグは、指定されたファイルに対してこの FRS 圧縮機能を無効にします。

このフラグは Windows 10 以降でのみサポートされます。

MARK_HANDLE_ENABLE_USN_SOURCE_ON_PAGING_IO
0x00002000
USN ジャーナルのページング書き込みに対して、指定された UsnSourceInfo の値を設定するよう NTFS に指示します。従来、システムはどのスレッドが変更を行ったのかを把握できないため、ページング書き込みではこれは行われませんでした。これはそのオーバーライドです。これは、メモリマネージャーが使用している FileObject にこの状態が関連付けられている場合にのみ機能します。

このフラグは Windows 10 以降でのみサポートされます。

MARK_HANDLE_SKIP_COHERENCY_SYNC_DISALLOW_WRITES
0x00004000
このフラグを設定すると、このファイルへの書き込みが許可されないことをシステムに伝えます。アプリケーションが書き込みアクセスでファイルを開こうとすると、その操作は STATUS_ACCESS_DENIED で失敗します。書き込みが検出された場合、その操作は STATUS_MARKED_TO_DISALLOW_WRITES で失敗します。

このフラグは Windows 10 以降でのみサポートされます。

共用体: _Anonymous_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
UsnSourceInfoDWORD4+0+0

行われる変更の種類です。

この操作は、ファイルまたはディレクトリを作成したアプリケーションから見て、外部的にはそれらを変更しません。

スレッドが新しい USN レコードを書き込むとき、直前のレコードのソース情報フラグは、そのスレッドが同じフラグも設定した場合にのみ引き続き保持されます。そのため、ソース情報構造体によって、アプリケーションはアンチウイルスフィルターなどの既知のソースだけが設定した USN レコードを除外できます。

次の値が定義されています。

意味
USN_SOURCE_DATA_MANAGEMENT
0x00000001
この操作は、オペレーティングシステムによって行われたファイルまたはディレクトリへの変更に関する情報を提供します。

典型的な用途は、リモート記憶域が外部ストレージからローカルストレージへデータを移動する場合です。リモート記憶域は階層型ストレージ管理ソフトウェアです。このような移動では、通常、少なくとも USN_REASON_DATA_OVERWRITE フラグが USN レコードに追加されます。しかし、ユーザーの観点からはデータは変更されていません。レコードを保持する USN_RECORD 構造体の SourceInfo メンバーに USN_SOURCE_DATA_MANAGEMENT があることに注目すれば、その項目に対して書き込み操作が行われたにもかかわらずデータは変更されていない、と判断できます。

USN_SOURCE_AUXILIARY_DATA
0x00000002
この操作は、ファイルまたはディレクトリにプライベートデータストリームを追加します。

例としては、ウイルス検出プログラムがチェックサム情報を追加する場合が挙げられます。ウイルス検出プログラムが項目を変更すると、システムは USN レコードを生成します。USN_SOURCE_AUXILIARY_DATA は、その変更がアプリケーションのデータを変更していないことを示します。

USN_SOURCE_REPLICATION_MANAGEMENT
0x00000004
この操作は、レプリケートされたファイルの内容を作成または更新します。

たとえば、ファイル レプリケーション サービスは、レプリケートされたディレクトリ内のファイルを作成または更新するときにこのフラグを設定します。

USN_SOURCE_CLIENT_REPLICATION_MANAGEMENT
0x00000008
クラウドまたはサーバーから、クライアントシステム上でレプリケーションが実行されています。
CopyNumberDWORD4+0+0

後続の読み取りに使用する、0 から始まるコピー番号です。これは記憶域スペース、NTFS および ReFS 上のストリーム、ならびに ReFS 上の整合性ストリーム以外のストリームで使用します (ReFS の整合性ストリームはこれを自動的に処理します)。

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: このメンバーは Windows 8 および Windows Server 2012 より前ではサポートされません。

公式ドキュメント

指定されたファイルまたはディレクトリと、その更新シーケンス番号 (USN) 変更ジャーナルレコードに変更に関するデータをマークするために使用される情報を格納します。この構造体は FSCTL_MARK_HANDLE 制御コードで使用されます。

解説(Remarks)

ボリュームへのハンドルを取得するには、lpFileName パラメーターに次の形式の文字列を指定して CreateFile を呼び出します。

"\\.\X:"

上記の文字列の X は、そのボリュームが割り当てられているドライブを識別する文字です。

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

各言語での定義

#include <windows.h>

// MARK_HANDLE_INFO  (x64 24 / x86 12 バイト)
typedef struct MARK_HANDLE_INFO {
    _Anonymous_e__Union Anonymous;
    HANDLE VolumeHandle;
    DWORD HandleInfo;
} MARK_HANDLE_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct MARK_HANDLE_INFO
{
    public _Anonymous_e__Union Anonymous;
    public IntPtr VolumeHandle;
    public uint HandleInfo;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure MARK_HANDLE_INFO
    Public Anonymous As _Anonymous_e__Union
    Public VolumeHandle As IntPtr
    Public HandleInfo As UInteger
End Structure
import ctypes
from ctypes import wintypes

class MARK_HANDLE_INFO(ctypes.Structure):
    _fields_ = [
        ("Anonymous", _Anonymous_e__Union),
        ("VolumeHandle", ctypes.c_void_p),
        ("HandleInfo", wintypes.DWORD),
    ]
#[repr(C)]
pub struct MARK_HANDLE_INFO {
    pub Anonymous: _Anonymous_e__Union,
    pub VolumeHandle: *mut core::ffi::c_void,
    pub HandleInfo: u32,
}
import "golang.org/x/sys/windows"

type MARK_HANDLE_INFO struct {
	Anonymous _Anonymous_e__Union
	VolumeHandle uintptr
	HandleInfo uint32
}
type
  MARK_HANDLE_INFO = record
    Anonymous: _Anonymous_e__Union;
    VolumeHandle: Pointer;
    HandleInfo: DWORD;
  end;
const MARK_HANDLE_INFO = extern struct {
    Anonymous: _Anonymous_e__Union,
    VolumeHandle: ?*anyopaque,
    HandleInfo: u32,
};
type
  MARK_HANDLE_INFO {.bycopy.} = object
    Anonymous: _Anonymous_e__Union
    VolumeHandle: pointer
    HandleInfo: uint32
struct MARK_HANDLE_INFO
{
    _Anonymous_e__Union Anonymous;
    void* VolumeHandle;
    uint HandleInfo;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; MARK_HANDLE_INFO サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; Anonymous : _Anonymous_e__Union (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; VolumeHandle : HANDLE (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; HandleInfo : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; MARK_HANDLE_INFO サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; Anonymous : _Anonymous_e__Union (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; VolumeHandle : HANDLE (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; HandleInfo : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global MARK_HANDLE_INFO
    #field byte Anonymous 4
    #field intptr VolumeHandle
    #field int HandleInfo
#endstruct

stdim st, MARK_HANDLE_INFO        ; NSTRUCT 変数を確保
st->HandleInfo = 100
mes "HandleInfo=" + st->HandleInfo
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。