ホーム › Storage.FileSystem › ScanLogContainers

ScanLogContainers

関数

スキャンコンテキストでCLFSログコンテナを列挙する。

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

シグネチャ

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

BOOL ScanLogContainers(
    CLS_SCAN_CONTEXT* pcxScan,
    BYTE eScanMode,
    void* pReserved
);

パラメーター

名前

型

方向

説明

pcxScan

CLS_SCAN_CONTEXT*

inout

CreateLogContainerScanContext 関数によって初期化される、クライアントが割り当てた CLFS_SCAN_CONTEXT 構造体へのポインターです。

eScanMode

BYTE

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

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

Value	Meaning
CLFS_SCAN_INIT	スキャンコンテキストを再初期化しますが、関連するストレージは割り当てません。現在のスキャンコンテキストに格納されているすべてのデータが失われるため、この初期化は破壊的です。
CLFS_SCAN_CLOSE	スキャンコンテキストの初期化を解除し、スキャンコンテキストに関連付けられたシステムストレージを解放します。
CLFS_SCAN_FORWARD	次回の ScanLogContainers の呼び出しを順方向に進めます。 CLFS_SCAN_BACKWARD が指定されている場合は使用できません。
CLFS_SCAN_BACKWARD	次回の ScanLogContainers の呼び出しを逆方向に進めます。 CLFS_SCAN_FORWARD が指定されている場合は使用できません。

pReserved

void*

inout

予約済みです。pReserved には NULL を設定してください。

戻り値の型: BOOL

公式ドキュメント

ログコンテナーを列挙します。すべてのログコンテナーを反復処理するには、この関数を繰り返し呼び出します。

戻り値

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

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

次の一覧は、発生する可能性のあるエラーコードを示しています。

解説(Remarks)

ログコンテナーの ID は pcxScan->pinfoContainer->LogicalContainerId に返されます。

Note Common Log File System (CLFS) のスキャンコンテキストはスレッドセーフではありません。複数のスレッドから同時に使用したり、複数の非同期スキャンに同時に渡したりしないでください。

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 ScanLogContainers(
    CLS_SCAN_CONTEXT* pcxScan,
    BYTE eScanMode,
    void* pReserved
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ScanLogContainers(
    IntPtr pcxScan,   // CLS_SCAN_CONTEXT* in/out
    byte eScanMode,   // BYTE
    IntPtr pReserved   // void* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ScanLogContainers(
    pcxScan As IntPtr,   ' CLS_SCAN_CONTEXT* in/out
    eScanMode As Byte,   ' BYTE
    pReserved As IntPtr   ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pcxScan : CLS_SCAN_CONTEXT* in/out
' eScanMode : BYTE
' pReserved : void* in/out
Declare PtrSafe Function ScanLogContainers Lib "clfsw32" ( _
    ByVal pcxScan As LongPtr, _
    ByVal eScanMode As Byte, _
    ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScanLogContainers = ctypes.windll.clfsw32.ScanLogContainers
ScanLogContainers.restype = wintypes.BOOL
ScanLogContainers.argtypes = [
    ctypes.c_void_p,  # pcxScan : CLS_SCAN_CONTEXT* in/out
    ctypes.c_ubyte,  # eScanMode : BYTE
    ctypes.POINTER(None),  # pReserved : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
ScanLogContainers = Fiddle::Function.new(
  lib['ScanLogContainers'],
  [
    Fiddle::TYPE_VOIDP,  # pcxScan : CLS_SCAN_CONTEXT* in/out
    -Fiddle::TYPE_CHAR,  # eScanMode : BYTE
    Fiddle::TYPE_VOIDP,  # pReserved : void* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ScanLogContainers(
        pcxScan: *mut CLS_SCAN_CONTEXT,  // CLS_SCAN_CONTEXT* in/out
        eScanMode: u8,  // BYTE
        pReserved: *mut ()  // void* 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 ScanLogContainers(IntPtr pcxScan, byte eScanMode, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ScanLogContainers' -Namespace Win32 -PassThru
# $api::ScanLogContainers(pcxScan, eScanMode, pReserved)

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

出力引数:

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