TXFS_QUERY_RM_INFORMATION structure (winioctl.h)
[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]
Contains information about the resource manager (RM).
Syntax
typedef struct _TXFS_QUERY_RM_INFORMATION {
DWORD BytesRequired;
DWORDLONG TailLsn;
DWORDLONG CurrentLsn;
DWORDLONG ArchiveTailLsn;
DWORDLONG LogContainerSize;
LARGE_INTEGER HighestVirtualClock;
DWORD LogContainerCount;
DWORD LogContainerCountMax;
DWORD LogContainerCountMin;
DWORD LogGrowthIncrement;
DWORD LogAutoShrinkPercentage;
DWORD Flags;
WORD LoggingMode;
WORD Reserved;
DWORD RmState;
DWORDLONG LogCapacity;
DWORDLONG LogFree;
DWORDLONG TopsSize;
DWORDLONG TopsUsed;
DWORDLONG TransactionCount;
DWORDLONG OnePCCount;
DWORDLONG TwoPCCount;
DWORDLONG NumberLogFileFull;
DWORDLONG OldestTransactionAge;
GUID RMName;
DWORD TmLogPathOffset;
} TXFS_QUERY_RM_INFORMATION, *PTXFS_QUERY_RM_INFORMATION;
Members
BytesRequired
If FSCTL_TXFS_QUERY_RM_INFORMATION returns ERROR_BUFFER_TOO_SMALL, this member specifies the minimum number of bytes needed to return the information requested, including the NULL terminating character.
TailLsn
The oldest log sequence number (LSN) currently used by the RM.
CurrentLsn
The LSN most recently used by the RM in its log.
ArchiveTailLsn
The LSN of the archive tail of the log.
LogContainerSize
The actual size of a log container, in bytes.
HighestVirtualClock
The highest timestamp associated with a log record.
LogContainerCount
The number of log containers.
LogContainerCountMax
The maximum number of log containers.
LogContainerCountMin
The minimum number of containers allowed in the log.
LogGrowthIncrement
The amount the log will grow by, which is either a number of containers or percentage of the log size; the growth type used is specified by the flags set in Flags member.
LogAutoShrinkPercentage
If the auto-shrink policy is active, this member specifies the maximum allowable amount of free space in the log. If this member is zero, the auto-shrink policy is not active.
Flags
This member can be one or more of the following values.
| Value | Meaning |
|---|---|
|
If the flag is set, the RM's log is allowed to shrink as far as possible. This flag is mutually exclusive with TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MAX. |
|
Indicates the type of value in LogGrowthIncrement. If this flag is set, LogGrowthIncrement is a number of containers. This flag is mutually exclusive with TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_PERCENT. |
|
Indicates the type of value in LogGrowthIncrement. If this flag is set, LogGrowthIncrement is a percentage. This flag is mutually exclusive with TXFS_RM_FLAG_LOG_GROWTH_INCREMENT_NUM_CONTAINERS. |
|
Indicates that the RM's log can grow without bounds. This flag is mutually exclusive with TXFS_RM_FLAG_LOG_NO_CONTAINER_COUNT_MIN. |
|
Indicates the current state of the RM reset flag. If this is set, the RM will reset itself the next time it is started. This flag is only valid for default RMs, not secondary RMs. This flag is mutually exclusive with TXFS_RM_FLAG_DO_NOT_RESET_RM_AT_NEXT_START. |
|
Indicates the current state of the RM reset flag. If this is set, the RM will not reset itself the next time it is started. This flag is only valid for default RMs, not secondary RMs. This flag is mutually exclusive with TXFS_RM_FLAG_RESET_RM_AT_NEXT_START. |
|
Indicates that the RM is to prefer transaction consistency over system availability. This flag is mutually exclusive with TXFS_RM_FLAG_PREFER_AVAILABILITY and is not supported by the default RM on the system volume. |
|
Indicates that the RM is to prefer system availability over transaction consistency. This flag is mutually exclusive with TXFS_RM_FLAG_PREFER_CONSISTENCY and is forced by the default RM on the system volume. |
LoggingMode
The current logging mode.
| Value | Meaning |
|---|---|
|
Simple logging is used. |
|
Full logging is used |
Reserved
Reserved.
RmState
The state of the RM. Valid values are as follows.
LogCapacity
The total capacity of the log, in bytes.
LogFree
The number of bytes free in the log.
TopsSize
The size of the $Tops file, in bytes.
TopsUsed
The amount of the $Tops file that is in use, in bytes.
TransactionCount
The number of active transactions, at the time the query was issued.
OnePCCount
The number of single-phase commit operations that have occurred on this RM.
TwoPCCount
The number of two-phase commit operations that have occurred on this RM.
NumberLogFileFull
The number of times this RM's log has become full.
OldestTransactionAge
The length of the oldest active transaction, in milliseconds.
RMName
The GUID that indicates the name of this RM.
TmLogPathOffset
The offset from the beginning of this structure to a NULL-terminated Unicode string that contains the path to the TM's log.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Header | winioctl.h (include Windows.h) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for