ホーム › Storage.FileSystem › CreateLogContainerScanContext

CreateLogContainerScanContext

関数

CLFSログコンテナ列挙用のスキャンコンテキストを作成する。

DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// clfsw32.dll
#include <windows.h>

BOOL CreateLogContainerScanContext(
    HANDLE hLog,
    DWORD cFromContainer,
    DWORD cContainers,
    BYTE eScanMode,
    CLS_SCAN_CONTEXT* pcxScan,
    OVERLAPPED* pOverlapped
);

パラメーター

名前

型

方向

説明

hLog

HANDLE

ログコンテナをスキャンする権限を持つ、CreateLogFile から取得したログへのハンドル。

このファイルは専用ログまたは多重化ログのいずれかです。

cFromContainer

DWORD

スキャンを開始するコンテナ。

このパラメーターは、ログ内のコンテナ数を基準とした序数です。

cContainers

DWORD

CreateLogContainerScanContext が割り当てる CLFS_CONTAINER_INFORMATION 構造体の数。

この数は各スキャン呼び出しでスキャンされるコンテナの数であり、返されるコンテナ数がこの値より小さい場合に呼び出し元はスキャンが完了したと判断できます。

終了時に、システムが割り当てた CLFS_CONTAINER_INFORMATION 構造体の配列へのポインターが、クライアントが割り当てた CLFS_SCAN_CONTEXT 構造体の pinfoContainer メンバーに格納されます。このメンバーは pcxScan パラメーターによって指されます(つまり "pcxScan->pinfoContainer[]")。配列内の構造体の実際の数は "pcxScan->cContainersReturned" に格納されます。

クライアントは、eScanMode パラメーターを CLFS_SCAN_CLOSE に設定して ScanLogContainers を呼び出し、この配列を解放する必要があります。そうしないとメモリリークが発生します。

eScanMode

BYTE

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

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

Value	Meaning
CLFS_SCAN_INIT	コンテナリストの最初のコンテナからスキャンを初期化または再初期化します。このモードはコンテナコンテキストを初期化し、cContainers で指定された最初のコンテナ記述子のセットを返します。
CLFS_SCAN_FORWARD	cContainers で指定された最初のコンテナのセットを返します。
CLFS_SCAN_BACKWARD	cContainers で指定された最後のコンテナのセットを返します。

pcxScan

CLS_SCAN_CONTEXT*

inout

クライアントが割り当てた CLFS_SCAN_CONTEXT 構造体へのポインター。クライアントが専用ログのログコンテナをスキャンする際に ScanLogContainers 関数に渡せるスキャンコンテキストを受け取ります。

pOverlapped

OVERLAPPED*

inout

非同期操作に必要な OVERLAPPED 構造体へのポインター。

非同期操作を使用しない場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

ScanLogContainers と共に使用してログに関連付けられたすべてのログコンテナを列挙するためのスキャンコンテキストを作成し、最初のスキャンを実行します。

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

次の一覧は、発生し得るエラーコードを示します。

解説(Remarks)

スキャンの完了後、クライアントは eScanMode パラメーターを CLFS_SCAN_CLOSE に設定して ScanLogContainers を再度呼び出し、システムが割り当てた CLFS_CONTAINER_INFORMATION 構造体の配列を解放する必要があります。そうしないとメモリリークが発生します。

Examples

この関数を使用する例については、Enumerating Log Containers を参照してください。

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

各言語での呼び出し定義

// clfsw32.dll
#include <windows.h>

BOOL CreateLogContainerScanContext(
    HANDLE hLog,
    DWORD cFromContainer,
    DWORD cContainers,
    BYTE eScanMode,
    CLS_SCAN_CONTEXT* pcxScan,
    OVERLAPPED* pOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CreateLogContainerScanContext(
    IntPtr hLog,   // HANDLE
    uint cFromContainer,   // DWORD
    uint cContainers,   // DWORD
    byte eScanMode,   // BYTE
    IntPtr pcxScan,   // CLS_SCAN_CONTEXT* in/out
    IntPtr pOverlapped   // OVERLAPPED* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateLogContainerScanContext(
    hLog As IntPtr,   ' HANDLE
    cFromContainer As UInteger,   ' DWORD
    cContainers As UInteger,   ' DWORD
    eScanMode As Byte,   ' BYTE
    pcxScan As IntPtr,   ' CLS_SCAN_CONTEXT* in/out
    pOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' cFromContainer : DWORD
' cContainers : DWORD
' eScanMode : BYTE
' pcxScan : CLS_SCAN_CONTEXT* in/out
' pOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function CreateLogContainerScanContext Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal cFromContainer As Long, _
    ByVal cContainers As Long, _
    ByVal eScanMode As Byte, _
    ByVal pcxScan As LongPtr, _
    ByVal pOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateLogContainerScanContext = ctypes.windll.clfsw32.CreateLogContainerScanContext
CreateLogContainerScanContext.restype = wintypes.BOOL
CreateLogContainerScanContext.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    wintypes.DWORD,  # cFromContainer : DWORD
    wintypes.DWORD,  # cContainers : DWORD
    ctypes.c_ubyte,  # eScanMode : BYTE
    ctypes.c_void_p,  # pcxScan : CLS_SCAN_CONTEXT* in/out
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
CreateLogContainerScanContext = Fiddle::Function.new(
  lib['CreateLogContainerScanContext'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    -Fiddle::TYPE_INT,  # cFromContainer : DWORD
    -Fiddle::TYPE_INT,  # cContainers : DWORD
    -Fiddle::TYPE_CHAR,  # eScanMode : BYTE
    Fiddle::TYPE_VOIDP,  # pcxScan : CLS_SCAN_CONTEXT* in/out
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn CreateLogContainerScanContext(
        hLog: *mut core::ffi::c_void,  // HANDLE
        cFromContainer: u32,  // DWORD
        cContainers: u32,  // DWORD
        eScanMode: u8,  // BYTE
        pcxScan: *mut CLS_SCAN_CONTEXT,  // CLS_SCAN_CONTEXT* in/out
        pOverlapped: *mut OVERLAPPED  // OVERLAPPED* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool CreateLogContainerScanContext(IntPtr hLog, uint cFromContainer, uint cContainers, byte eScanMode, IntPtr pcxScan, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_CreateLogContainerScanContext' -Namespace Win32 -PassThru
# $api::CreateLogContainerScanContext(hLog, cFromContainer, cContainers, eScanMode, pcxScan, pOverlapped)

#uselib "clfsw32.dll"
#func global CreateLogContainerScanContext "CreateLogContainerScanContext" sptr, sptr, sptr, sptr, sptr, sptr
; CreateLogContainerScanContext hLog, cFromContainer, cContainers, eScanMode, varptr(pcxScan), varptr(pOverlapped)   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; cFromContainer : DWORD -> "sptr"
; cContainers : DWORD -> "sptr"
; eScanMode : BYTE -> "sptr"
; pcxScan : CLS_SCAN_CONTEXT* in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global CreateLogContainerScanContext "CreateLogContainerScanContext" sptr, int, int, int, var, var
; res = CreateLogContainerScanContext(hLog, cFromContainer, cContainers, eScanMode, pcxScan, pOverlapped)
; hLog : HANDLE -> "sptr"
; cFromContainer : DWORD -> "int"
; cContainers : DWORD -> "int"
; eScanMode : BYTE -> "int"
; pcxScan : CLS_SCAN_CONTEXT* in/out -> "var"
; pOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global CreateLogContainerScanContext "CreateLogContainerScanContext" sptr, int, int, int, sptr, sptr
; res = CreateLogContainerScanContext(hLog, cFromContainer, cContainers, eScanMode, varptr(pcxScan), varptr(pOverlapped))
; hLog : HANDLE -> "sptr"
; cFromContainer : DWORD -> "int"
; cContainers : DWORD -> "int"
; eScanMode : BYTE -> "int"
; pcxScan : CLS_SCAN_CONTEXT* in/out -> "sptr"
; pOverlapped : OVERLAPPED* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。