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

REQUEST_OPLOCK_OUTPUT_BUFFER

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

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

フィールド

フィールドサイズx64x86説明
StructureVersionWORD2+0+0使用されている REQUEST_OPLOCK_OUTPUT_BUFFER 構造体のバージョンです。
StructureLengthWORD2+2+2この構造体の長さ (バイト単位) です。
OriginalOplockLevelDWORD4+4+4

解除された oplock のレベルを示す、1 つ以上の OPLOCK_LEVEL_CACHE_XXX 値です。

指定可能な値については、REQUEST_OPLOCK_INPUT_BUFFER 構造体の RequestedOplockLevel メンバーを参照してください。

NewOplockLevelDWORD4+8+8

oplock が解除される先のレベル、またはこのバッファーを返す操作によっては付与可能な oplock レベルを示す、1 つ以上の OPLOCK_LEVEL_CACHE_XXX 値です。

指定可能な値については、REQUEST_OPLOCK_INPUT_BUFFER 構造体の RequestedOplockLevel メンバーを参照してください。

FlagsDWORD4+12+12

1 つ以上の REQUEST_OPLOCK_OUTPUT_FLAG_XXX 値です。

意味
REQUEST_OPLOCK_OUTPUT_FLAG_ACK_REQUIRED
受信確認 (確認応答) が必要であり、OriginalOplockLevel に示された oplock は、解除が正常に確認応答されるまで有効なまま維持されることを示します。
REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED
ShareMode メンバーと AccessMode メンバーに、oplock の解除を引き起こした要求の共有フラグとアクセス フラグがそれぞれ格納されていることを示します。詳細については、「解説」を参照してください。
AccessModeDWORD4+16+16REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED フラグが設定されており、oplock の解除によって OPLOCK_LEVEL_CACHE_HANDLE レベルが失われる場合、その解除を引き起こしている要求のアクセス モードが格納されます。
ShareModeWORD2+20+20REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED フラグが設定されており、oplock の解除によって OPLOCK_LEVEL_CACHE_HANDLE レベルが失われる場合、その解除を引き起こしている要求の共有モードが格納されます。

公式ドキュメント

FSCTL_REQUEST_OPLOCK 制御コードによって返される便宜的ロック (oplock) の情報を格納します。

解説(Remarks)

REQUEST_OPLOCK_OUTPUT_FLAG_MODES_PROVIDED フラグは、ShareMode フィールドと AccessMode フィールドに、oplock の解除を引き起こした要求の共有フラグとアクセス フラグがそれぞれ格納されていることを示します。この情報は OPLOCK_LEVEL_CACHE_HANDLE レベルが失われる解除の際に提供されることがあり、解除を引き起こしているハンドルと共有モードおよびアクセス モードが競合するハンドルを閉じることができる呼び出し元にとって有用です。これにより、ハンドル キャッシュの状態を少なくとも部分的に維持できる場合があります。なお、OPLOCK_LEVEL_CACHE_HANDLE レベルが失われる解除のすべてでこのフラグが設定されるわけではありません。このフラグが設定される主なケースは、ERROR_SHARING_VIOLATION による失敗を回避するために OPLOCK_LEVEL_CACHE_HANDLE oplock の解除を必要とする作成操作が原因で解除が発生した場合です。

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

各言語での定義

#include <windows.h>

// REQUEST_OPLOCK_OUTPUT_BUFFER  (x64 24 / x86 24 バイト)
typedef struct REQUEST_OPLOCK_OUTPUT_BUFFER {
    WORD StructureVersion;
    WORD StructureLength;
    DWORD OriginalOplockLevel;
    DWORD NewOplockLevel;
    DWORD Flags;
    DWORD AccessMode;
    WORD ShareMode;
} REQUEST_OPLOCK_OUTPUT_BUFFER;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct REQUEST_OPLOCK_OUTPUT_BUFFER
{
    public ushort StructureVersion;
    public ushort StructureLength;
    public uint OriginalOplockLevel;
    public uint NewOplockLevel;
    public uint Flags;
    public uint AccessMode;
    public ushort ShareMode;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure REQUEST_OPLOCK_OUTPUT_BUFFER
    Public StructureVersion As UShort
    Public StructureLength As UShort
    Public OriginalOplockLevel As UInteger
    Public NewOplockLevel As UInteger
    Public Flags As UInteger
    Public AccessMode As UInteger
    Public ShareMode As UShort
End Structure
import ctypes
from ctypes import wintypes

class REQUEST_OPLOCK_OUTPUT_BUFFER(ctypes.Structure):
    _fields_ = [
        ("StructureVersion", ctypes.c_ushort),
        ("StructureLength", ctypes.c_ushort),
        ("OriginalOplockLevel", wintypes.DWORD),
        ("NewOplockLevel", wintypes.DWORD),
        ("Flags", wintypes.DWORD),
        ("AccessMode", wintypes.DWORD),
        ("ShareMode", ctypes.c_ushort),
    ]
#[repr(C)]
pub struct REQUEST_OPLOCK_OUTPUT_BUFFER {
    pub StructureVersion: u16,
    pub StructureLength: u16,
    pub OriginalOplockLevel: u32,
    pub NewOplockLevel: u32,
    pub Flags: u32,
    pub AccessMode: u32,
    pub ShareMode: u16,
}
import "golang.org/x/sys/windows"

type REQUEST_OPLOCK_OUTPUT_BUFFER struct {
	StructureVersion uint16
	StructureLength uint16
	OriginalOplockLevel uint32
	NewOplockLevel uint32
	Flags uint32
	AccessMode uint32
	ShareMode uint16
}
type
  REQUEST_OPLOCK_OUTPUT_BUFFER = record
    StructureVersion: Word;
    StructureLength: Word;
    OriginalOplockLevel: DWORD;
    NewOplockLevel: DWORD;
    Flags: DWORD;
    AccessMode: DWORD;
    ShareMode: Word;
  end;
const REQUEST_OPLOCK_OUTPUT_BUFFER = extern struct {
    StructureVersion: u16,
    StructureLength: u16,
    OriginalOplockLevel: u32,
    NewOplockLevel: u32,
    Flags: u32,
    AccessMode: u32,
    ShareMode: u16,
};
type
  REQUEST_OPLOCK_OUTPUT_BUFFER {.bycopy.} = object
    StructureVersion: uint16
    StructureLength: uint16
    OriginalOplockLevel: uint32
    NewOplockLevel: uint32
    Flags: uint32
    AccessMode: uint32
    ShareMode: uint16
struct REQUEST_OPLOCK_OUTPUT_BUFFER
{
    ushort StructureVersion;
    ushort StructureLength;
    uint OriginalOplockLevel;
    uint NewOplockLevel;
    uint Flags;
    uint AccessMode;
    ushort ShareMode;
}

HSP用 定義

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

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

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