Win32 API 日本語リファレンス
ホームStorage.FileSystem › CLS_SCAN_CONTEXT

CLS_SCAN_CONTEXT

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

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

フィールド

フィールドサイズx64x86説明
cidNodeCLFS_NODE_ID8+0+0現在のノードの ID です。詳細については、CLFS_NODE_ID を参照してください。
hLogHANDLE8/4+8+8スキャン対象のログへのハンドルです。ログコンテナーをスキャンする権限を指定して CreateLogFile から取得します。
cIndexDWORD4+16+12現在のコンテナーのインデックスです。
cContainersDWORD4+20+16

pinfoContainer が指す配列内にある、システムによって割り当てられた CLFS_CONTAINER_INFORMATION 構造体の数です。

つまり、このメンバーは 1 回のスキャン呼び出しでスキャンするコンテナーの数です。返されたコンテナーの数がこの値より少ない場合、呼び出し元はスキャンが完了したと判断できます。

cContainersReturnedDWORD4+24+20ScanLogContainers の呼び出し後に返されたコンテナーの数です。
eScanModeBYTE1+28+24

コンテナーをスキャンするモードです。

コンテナーは次のいずれかのモードでスキャンできます。

意味
CLFS_SCAN_INIT
スキャンコンテキストを初期化しますが、関連するストレージの割り当ては行いません。

現在のスキャンコンテキストに格納されているすべてのデータが失われるため、この初期化は破壊的です。

CLFS_SCAN_CLOSE
スキャンコンテキストの初期化を解除し、スキャンコンテキストに関連付けられたシステムストレージを解放します。
CLFS_SCAN_FORWARD
次回の ScanLogContainers の呼び出しが前方向に進むようにします。

CLFS_SCAN_BACKWARD が指定されている場合は使用できません。

CLFS_SCAN_BACKWARD
次回の ScanLogContainers の呼び出しが後方向に進むようにします。

CLFS_SCAN_FORWARD が指定されている場合は使用できません。

pinfoContainerCLS_CONTAINER_INFORMATION*8/4+32+28呼び出しが成功するたびに ScanLogContainers によって値が設定される、クライアントが割り当てた CLFS_CONTAINER_INFORMATION 構造体の配列へのポインターです。

公式ドキュメント

ScanLogContainers によってスキャンされるコンテナーに関する情報、実行されるスキャンの種類、およびどのコンテナーがスキャン済みかを追跡するためのカーソルが格納されます。

解説(Remarks)

この構造体はクライアントによって割り当てられ、CreateLogContainerScanContext を使用して初期化された後、ScanLogContainers への繰り返しの呼び出しに渡されます。

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

各言語での定義

#include <windows.h>

// CLFS_NODE_ID  (x64 8 / x86 8 バイト)
typedef struct CLFS_NODE_ID {
    DWORD cType;
    DWORD cbNode;
} CLFS_NODE_ID;

// CLS_SCAN_CONTEXT  (x64 40 / x86 32 バイト)
typedef struct CLS_SCAN_CONTEXT {
    CLFS_NODE_ID cidNode;
    HANDLE hLog;
    DWORD cIndex;
    DWORD cContainers;
    DWORD cContainersReturned;
    BYTE eScanMode;
    CLS_CONTAINER_INFORMATION* pinfoContainer;
} CLS_SCAN_CONTEXT;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CLFS_NODE_ID
{
    public uint cType;
    public uint cbNode;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CLS_SCAN_CONTEXT
{
    public CLFS_NODE_ID cidNode;
    public IntPtr hLog;
    public uint cIndex;
    public uint cContainers;
    public uint cContainersReturned;
    public byte eScanMode;
    public IntPtr pinfoContainer;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CLFS_NODE_ID
    Public cType As UInteger
    Public cbNode As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CLS_SCAN_CONTEXT
    Public cidNode As CLFS_NODE_ID
    Public hLog As IntPtr
    Public cIndex As UInteger
    Public cContainers As UInteger
    Public cContainersReturned As UInteger
    Public eScanMode As Byte
    Public pinfoContainer As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class CLFS_NODE_ID(ctypes.Structure):
    _fields_ = [
        ("cType", wintypes.DWORD),
        ("cbNode", wintypes.DWORD),
    ]

class CLS_SCAN_CONTEXT(ctypes.Structure):
    _fields_ = [
        ("cidNode", CLFS_NODE_ID),
        ("hLog", ctypes.c_void_p),
        ("cIndex", wintypes.DWORD),
        ("cContainers", wintypes.DWORD),
        ("cContainersReturned", wintypes.DWORD),
        ("eScanMode", ctypes.c_ubyte),
        ("pinfoContainer", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct CLFS_NODE_ID {
    pub cType: u32,
    pub cbNode: u32,
}

#[repr(C)]
pub struct CLS_SCAN_CONTEXT {
    pub cidNode: CLFS_NODE_ID,
    pub hLog: *mut core::ffi::c_void,
    pub cIndex: u32,
    pub cContainers: u32,
    pub cContainersReturned: u32,
    pub eScanMode: u8,
    pub pinfoContainer: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type CLFS_NODE_ID struct {
	cType uint32
	cbNode uint32
}

type CLS_SCAN_CONTEXT struct {
	cidNode CLFS_NODE_ID
	hLog uintptr
	cIndex uint32
	cContainers uint32
	cContainersReturned uint32
	eScanMode byte
	pinfoContainer uintptr
}
type
  CLFS_NODE_ID = record
    cType: DWORD;
    cbNode: DWORD;
  end;

  CLS_SCAN_CONTEXT = record
    cidNode: CLFS_NODE_ID;
    hLog: Pointer;
    cIndex: DWORD;
    cContainers: DWORD;
    cContainersReturned: DWORD;
    eScanMode: Byte;
    pinfoContainer: Pointer;
  end;
const CLFS_NODE_ID = extern struct {
    cType: u32,
    cbNode: u32,
};

const CLS_SCAN_CONTEXT = extern struct {
    cidNode: CLFS_NODE_ID,
    hLog: ?*anyopaque,
    cIndex: u32,
    cContainers: u32,
    cContainersReturned: u32,
    eScanMode: u8,
    pinfoContainer: ?*anyopaque,
};
type
  CLFS_NODE_ID {.bycopy.} = object
    cType: uint32
    cbNode: uint32

  CLS_SCAN_CONTEXT {.bycopy.} = object
    cidNode: CLFS_NODE_ID
    hLog: pointer
    cIndex: uint32
    cContainers: uint32
    cContainersReturned: uint32
    eScanMode: uint8
    pinfoContainer: pointer
struct CLFS_NODE_ID
{
    uint cType;
    uint cbNode;
}

struct CLS_SCAN_CONTEXT
{
    CLFS_NODE_ID cidNode;
    void* hLog;
    uint cIndex;
    uint cContainers;
    uint cContainersReturned;
    ubyte eScanMode;
    void* pinfoContainer;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CLS_SCAN_CONTEXT サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; cidNode : CLFS_NODE_ID (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; hLog : HANDLE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; cIndex : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; cContainers : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cContainersReturned : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; eScanMode : BYTE (+24, 1byte)  poke st,24,値  /  値 = peek(st,24)
; pinfoContainer : CLS_CONTAINER_INFORMATION* (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CLS_SCAN_CONTEXT サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; cidNode : CLFS_NODE_ID (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; hLog : HANDLE (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; cIndex : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cContainers : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; cContainersReturned : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; eScanMode : BYTE (+28, 1byte)  poke st,28,値  /  値 = peek(st,28)
; pinfoContainer : CLS_CONTAINER_INFORMATION* (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global CLFS_NODE_ID
    #field int cType
    #field int cbNode
#endstruct

#defstruct global CLS_SCAN_CONTEXT
    #field CLFS_NODE_ID cidNode
    #field intptr hLog
    #field int cIndex
    #field int cContainers
    #field int cContainersReturned
    #field byte eScanMode
    #field intptr pinfoContainer
#endstruct

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