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

TXFS_MODIFY_RM

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

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

フィールド

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

設定するログパラメーターです。

このメンバーには、次の値の 1 つ以上を指定できます。

意味
TXFS_RM_FLAG_LOGGING_MODE
0x00000001
このフラグが設定されている場合、この構造体の LoggingMode メンバーが使用されます。 フラグが設定されていない場合、LoggingMode メンバーは無視されます。
TXFS_RM_FLAG_RENAME_RM
0x00000002
このフラグが設定されている場合、RM は自身の名前を変更する (新しい GUID を作成する) よう指示されます。
TXFS_RM_FLAG_LOG_CONTAINER_COUNT_MAX
0x00000004
このフラグが設定されている場合、LogContainerCountMax メンバーが使用されます。 フラグが設定されていない場合、LogContainerCountMax メンバーは無視されます。このフラグは TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MIN と相互排他的です。
TXFS_RM_FLAG_LOG_CONTAINER_COUNT_MIN
0x00000008
このフラグが設定されている場合、LogContainerCountMin メンバーが使用されます。 フラグが設定されていない場合、LogContainerCountMin メンバーは無視されます。このフラグは TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MAX と相互排他的です。
TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_NUM_CONTAINERS
0x00000010
このフラグが設定されている場合、LogGrowthIncrement メンバーが使用されます。 フラグが設定されていない場合、LogGrowthIncrement メンバーは無視されます。このフラグは、 LogGrowthIncrement メンバーで指定されたコンテナー数だけログを拡張することを示します。 このフラグは TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_PERCENT と相互排他的です。
TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_PERCENT
0x00000020
このフラグが設定されている場合、LogGrowthIncrement メンバーが使用されます。 フラグが設定されていない場合、LogGrowthIncrement メンバーは無視されます。このフラグは、 LogGrowthIncrement メンバーで指定されたログサイズの割合だけログを拡張することを示します。 このフラグは TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_NUM_CONTAINERS と相互排他的です。
TXFS_RM_FLAG_LOG_AUTO_SHRINK_PERCENTAGE
0x00000040
このフラグが設定されている場合、LogAutoShrinkPercentage メンバーが使用されます。 フラグが設定されていない場合、LogAutoShrinkPercentage は無視されます。
TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MAX
0x00000080
このフラグが設定されている場合、RM は自身のログを制限なく拡張できるよう指示されます。このフラグは TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MIN と相互排他的です。
TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MIN
0x00000100
このフラグが設定されている場合、RM は自身のログをコンテナー 2 つ分まで縮小できるよう指示されます。 このフラグは TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MAX と相互排他的です。
TXFS_RM_FLAG_GROW_LOG
0x00000400
このフラグが設定されている場合、ログは LogContainerCount で指定されたサイズまで直ちに拡張するよう 指示されます。フラグが設定されていない場合、LogContainerCount は無視されます。
TXFS_RM_FLAG_SHRINK_LOG
0x00000800
このフラグが設定されている場合、ログは LogContainerCount で指定されたサイズまで直ちに縮小するよう 指示されます。このフラグと TXFS_RM_FLAG_ENFORCE_MINIMUM_SIZE の両方が設定されている場合、 ログは許容される最小サイズまで縮小するよう指示され、LogContainerCount は無視されます。
TXFS_RM_FLAG_ENFORCE_MINIMUM_SIZE
0x00001000
このフラグと TXFS_RM_FLAG_SHRINK_LOG が設定されている場合、ログは許容される最小サイズまで 縮小するよう指示され、LogContainerCount は無視されます。このフラグを設定する場合は、 TXFS_RM_FLAG_SHRINK_LOG も設定されていなければなりません。
TXFS_RM_FLAG_PRESERVE_CHANGES
0x00002000
このフラグが設定されている場合、ログは変更をディスク上に保持するよう指示されます。このフラグが設定されていない場合、 行われた変更は一時的なもの (つまり RM がシャットダウンされて再起動されるまでのもの) になります。
TXFS_RM_FLAG_RESET_RM_AT_NEXT_START
0x00004000
このフラグは既定の RM に対してのみ有効であり、セカンダリ RM では無効です。このフラグが設定されている場合、 RM は次回の起動時に自身をリセットするよう指示されます。ログおよび関連するメタデータは削除されます。
TXFS_RM_FLAG_DO_NOT_RESET_RM_AT_NEXT_START
0x00008000
このフラグは既定の RM に対してのみ有効であり、セカンダリ RM では無効です。このフラグが設定されている場合、 TXFS_RM_FLAG_RESET_RM_AT_NEXT_START フラグを設定して行われた以前の FSCTL_TXFS_MODIFY_RM の呼び出しが 取り消されます。
TXFS_RM_FLAG_PREFER_CONSISTENCY
0x00010000
RM がトランザクションの 一貫性をシステムの 可用性よりも優先することを示します。このフラグは TXFS_RM_FLAG_PREFER_AVAILABILITY と相互排他的であり、システムボリューム上の既定の RM では サポートされません。
TXFS_RM_FLAG_PREFER_AVAILABILITY
0x00020000
RM がシステムの 可用性をトランザクションの 一貫性よりも優先することを示します。このフラグは TXFS_RM_FLAG_PREFER_CONSISTENCY と相互排他的であり、システムボリューム上の既定の RM では 強制的に適用されます。
LogContainerCountMaxDWORD4+4+4ログの最大サイズ (コンテナー数) です。
LogContainerCountMinDWORD4+8+8ログの最小サイズ (コンテナー数) です。
LogContainerCountDWORD4+12+12ログの実際のサイズ (コンテナー数) です。
LogGrowthIncrementDWORD4+16+16ログに追加するコンテナー数、または領域の割合です。
LogAutoShrinkPercentageDWORD4+20+20空き状態に保つログ領域の割合です。このメンバーは TXFS_RM_FLAG_LOG_AUTO_SHRINK_PERCENTAGE フラグが使用されるときに用いられ、ログの空き領域が常に LogAutoShrinkPercentage を超えないようにログを自動的に縮小するよう指示します。
ReservedULONGLONG8+24+24予約済みです。
LoggingModeWORD2+32+32

現在のログモードです。

意味
TXFS_LOGGING_MODE_SIMPLE
1
簡易ログ記録が使用されます。
TXFS_LOGGING_MODE_FULL
2
完全ログ記録が使用されます

公式ドキュメント

[Microsoft は、アプリケーションのニーズを満たすために代替手段を利用することを強く推奨します。TxF が開発された目的の多くのシナリオは、より単純で容易に利用できる手法によって実現できます。さらに、TxF は将来のバージョンの Microsoft Windows では利用できなくなる可能性があります。詳細および TxF の代替手段については、 トランザクション NTFS の代替手段を参照してください。]

セカンダリリソースマネージャーのログパラメーターとログモードを変更する際に必要な情報を格納します。

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

各言語での定義

#include <windows.h>

// TXFS_MODIFY_RM  (x64 40 / x86 40 バイト)
typedef struct TXFS_MODIFY_RM {
    TXFS_RMF_LAGS Flags;
    DWORD LogContainerCountMax;
    DWORD LogContainerCountMin;
    DWORD LogContainerCount;
    DWORD LogGrowthIncrement;
    DWORD LogAutoShrinkPercentage;
    ULONGLONG Reserved;
    WORD LoggingMode;
} TXFS_MODIFY_RM;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TXFS_MODIFY_RM
{
    public uint Flags;
    public uint LogContainerCountMax;
    public uint LogContainerCountMin;
    public uint LogContainerCount;
    public uint LogGrowthIncrement;
    public uint LogAutoShrinkPercentage;
    public ulong Reserved;
    public ushort LoggingMode;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TXFS_MODIFY_RM
    Public Flags As UInteger
    Public LogContainerCountMax As UInteger
    Public LogContainerCountMin As UInteger
    Public LogContainerCount As UInteger
    Public LogGrowthIncrement As UInteger
    Public LogAutoShrinkPercentage As UInteger
    Public Reserved As ULong
    Public LoggingMode As UShort
End Structure
import ctypes
from ctypes import wintypes

class TXFS_MODIFY_RM(ctypes.Structure):
    _fields_ = [
        ("Flags", wintypes.DWORD),
        ("LogContainerCountMax", wintypes.DWORD),
        ("LogContainerCountMin", wintypes.DWORD),
        ("LogContainerCount", wintypes.DWORD),
        ("LogGrowthIncrement", wintypes.DWORD),
        ("LogAutoShrinkPercentage", wintypes.DWORD),
        ("Reserved", ctypes.c_ulonglong),
        ("LoggingMode", ctypes.c_ushort),
    ]
#[repr(C)]
pub struct TXFS_MODIFY_RM {
    pub Flags: u32,
    pub LogContainerCountMax: u32,
    pub LogContainerCountMin: u32,
    pub LogContainerCount: u32,
    pub LogGrowthIncrement: u32,
    pub LogAutoShrinkPercentage: u32,
    pub Reserved: u64,
    pub LoggingMode: u16,
}
import "golang.org/x/sys/windows"

type TXFS_MODIFY_RM struct {
	Flags uint32
	LogContainerCountMax uint32
	LogContainerCountMin uint32
	LogContainerCount uint32
	LogGrowthIncrement uint32
	LogAutoShrinkPercentage uint32
	Reserved uint64
	LoggingMode uint16
}
type
  TXFS_MODIFY_RM = record
    Flags: DWORD;
    LogContainerCountMax: DWORD;
    LogContainerCountMin: DWORD;
    LogContainerCount: DWORD;
    LogGrowthIncrement: DWORD;
    LogAutoShrinkPercentage: DWORD;
    Reserved: UInt64;
    LoggingMode: Word;
  end;
const TXFS_MODIFY_RM = extern struct {
    Flags: u32,
    LogContainerCountMax: u32,
    LogContainerCountMin: u32,
    LogContainerCount: u32,
    LogGrowthIncrement: u32,
    LogAutoShrinkPercentage: u32,
    Reserved: u64,
    LoggingMode: u16,
};
type
  TXFS_MODIFY_RM {.bycopy.} = object
    Flags: uint32
    LogContainerCountMax: uint32
    LogContainerCountMin: uint32
    LogContainerCount: uint32
    LogGrowthIncrement: uint32
    LogAutoShrinkPercentage: uint32
    Reserved: uint64
    LoggingMode: uint16
struct TXFS_MODIFY_RM
{
    uint Flags;
    uint LogContainerCountMax;
    uint LogContainerCountMin;
    uint LogContainerCount;
    uint LogGrowthIncrement;
    uint LogAutoShrinkPercentage;
    ulong Reserved;
    ushort LoggingMode;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TXFS_MODIFY_RM サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; Flags : TXFS_RMF_LAGS (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; LogContainerCountMax : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; LogContainerCountMin : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; LogContainerCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; LogGrowthIncrement : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; LogAutoShrinkPercentage : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; Reserved : ULONGLONG (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; LoggingMode : WORD (+32, 2byte)  wpoke st,32,値  /  値 = wpeek(st,32)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TXFS_MODIFY_RM
    #field int Flags
    #field int LogContainerCountMax
    #field int LogContainerCountMin
    #field int LogContainerCount
    #field int LogGrowthIncrement
    #field int LogAutoShrinkPercentage
    #field int64 Reserved
    #field short LoggingMode
#endstruct

stdim st, TXFS_MODIFY_RM        ; NSTRUCT 変数を確保
st->Flags = 100
mes "Flags=" + st->Flags